From 85034eb76b00b1db4c40312bd9e7b8b9ff8f3123 Mon Sep 17 00:00:00 2001 From: Suresh Kumar Anaparti Date: Fri, 28 Nov 2025 11:58:30 +0530 Subject: [PATCH 1/2] Updated SDK with 4.22.0 APIs --- cloudstack/BackupService.go | 425 +- cloudstack/BackupService_mock.go | 29 +- cloudstack/ConfigurationService.go | 2 + cloudstack/HostService.go | 25 + cloudstack/InternalLBService.go | 3 + cloudstack/KubernetesService.go | 39 + cloudstack/LDAPService.go | 91 +- cloudstack/LDAPService_mock.go | 29 +- cloudstack/LoadBalancerService.go | 51 + cloudstack/MetricsService.go | 31 +- cloudstack/NetworkService.go | 36 +- cloudstack/NetworkService_mock.go | 8 +- cloudstack/PoolService.go | 5 + cloudstack/RouterService.go | 6 + cloudstack/ServiceOfferingService.go | 25 + cloudstack/SnapshotService.go | 125 + cloudstack/StoragePoolService.go | 3 + cloudstack/SystemVMService.go | 29 +- cloudstack/TemplateService.go | 24 + cloudstack/VirtualMachineService.go | 128 +- generate/listApis.json | 164177 ++++++++++++------------ test/BackupService_test.go | 2 +- test/LDAPService_test.go | 12 +- 23 files changed, 83891 insertions(+), 81414 deletions(-) diff --git a/cloudstack/BackupService.go b/cloudstack/BackupService.go index 454b12e9..bdfde23d 100644 --- a/cloudstack/BackupService.go +++ b/cloudstack/BackupService.go @@ -62,7 +62,8 @@ type BackupServiceIface interface { 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 + NewListBackupScheduleParams() *ListBackupScheduleParams + GetBackupScheduleByID(id string, opts ...OptionFunc) (*BackupSchedule, int, error) ListBackups(p *ListBackupsParams) (*ListBackupsResponse, error) NewListBackupsParams() *ListBackupsParams GetBackupID(name string, opts ...OptionFunc) (string, int, error) @@ -92,6 +93,10 @@ func (p *AddBackupRepositoryParams) toURLValues() url.Values { vv := strconv.FormatInt(v.(int64), 10) u.Set("capacitybytes", vv) } + if v, found := p.p["crosszoneinstancecreation"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("crosszoneinstancecreation", vv) + } if v, found := p.p["mountopts"]; found { u.Set("mountopts", v.(string)) } @@ -152,6 +157,27 @@ func (p *AddBackupRepositoryParams) GetCapacitybytes() (int64, bool) { return value, ok } +func (p *AddBackupRepositoryParams) SetCrosszoneinstancecreation(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["crosszoneinstancecreation"] = v +} + +func (p *AddBackupRepositoryParams) ResetCrosszoneinstancecreation() { + if p.p != nil && p.p["crosszoneinstancecreation"] != nil { + delete(p.p, "crosszoneinstancecreation") + } +} + +func (p *AddBackupRepositoryParams) GetCrosszoneinstancecreation() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["crosszoneinstancecreation"].(bool) + return value, ok +} + func (p *AddBackupRepositoryParams) SetMountopts(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -285,17 +311,18 @@ func (s *BackupService) AddBackupRepository(p *AddBackupRepositoryParams) (*AddB } 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"` + Address string `json:"address"` + Capacitybytes int64 `json:"capacitybytes"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -650,6 +677,7 @@ type CreateBackupScheduleResponse struct { Externalid string `json:"externalid"` Id string `json:"id"` Intervaltype string `json:"intervaltype"` + Isbackupvmexpunged bool `json:"isbackupvmexpunged"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -2943,17 +2971,18 @@ func (s *BackupService) ImportBackupOffering(p *ImportBackupOfferingParams) (*Im } 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"` + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -3202,17 +3231,18 @@ type ListBackupOfferingsResponse struct { } 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"` + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -3392,17 +3422,18 @@ type ListBackupProviderOfferingsResponse struct { } 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"` + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -3770,17 +3801,18 @@ type ListBackupRepositoriesResponse struct { } 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"` + Address string `json:"address"` + Capacitybytes int64 `json:"capacitybytes"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -3792,12 +3824,232 @@ func (p *ListBackupScheduleParams) toURLValues() 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["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)) } return u } +func (p *ListBackupScheduleParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListBackupScheduleParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *ListBackupScheduleParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *ListBackupScheduleParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListBackupScheduleParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *ListBackupScheduleParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + +func (p *ListBackupScheduleParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListBackupScheduleParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListBackupScheduleParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *ListBackupScheduleParams) SetIsrecursive(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isrecursive"] = v +} + +func (p *ListBackupScheduleParams) ResetIsrecursive() { + if p.p != nil && p.p["isrecursive"] != nil { + delete(p.p, "isrecursive") + } +} + +func (p *ListBackupScheduleParams) GetIsrecursive() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isrecursive"].(bool) + return value, ok +} + +func (p *ListBackupScheduleParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListBackupScheduleParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListBackupScheduleParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListBackupScheduleParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *ListBackupScheduleParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *ListBackupScheduleParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + +func (p *ListBackupScheduleParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListBackupScheduleParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListBackupScheduleParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListBackupScheduleParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListBackupScheduleParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListBackupScheduleParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListBackupScheduleParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListBackupScheduleParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *ListBackupScheduleParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + func (p *ListBackupScheduleParams) SetVirtualmachineid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -3821,13 +4073,45 @@ func (p *ListBackupScheduleParams) GetVirtualmachineid() (string, bool) { // 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 { +func (s *BackupService) NewListBackupScheduleParams() *ListBackupScheduleParams { p := &ListBackupScheduleParams{} p.p = make(map[string]interface{}) - p.p["virtualmachineid"] = virtualmachineid return p } +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *BackupService) GetBackupScheduleByID(id string, opts ...OptionFunc) (*BackupSchedule, int, error) { + p := &ListBackupScheduleParams{} + 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.ListBackupSchedule(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.BackupSchedule[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for BackupSchedule UUID: %s!", id) +} + // List backup schedule of a VM func (s *BackupService) ListBackupSchedule(p *ListBackupScheduleParams) (*ListBackupScheduleResponse, error) { resp, err := s.cs.newRequest("listBackupSchedule", p.toURLValues()) @@ -4337,6 +4621,7 @@ type Backup struct { Externalid string `json:"externalid"` Id string `json:"id"` Intervaltype string `json:"intervaltype"` + Isbackupvmexpunged bool `json:"isbackupvmexpunged"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` @@ -4569,17 +4854,18 @@ func (s *BackupService) UpdateBackupOffering(p *UpdateBackupOfferingParams) (*Up } 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"` + Allowuserdrivenbackups bool `json:"allowuserdrivenbackups"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 { @@ -4779,6 +5065,7 @@ type UpdateBackupScheduleResponse struct { Externalid string `json:"externalid"` Id string `json:"id"` Intervaltype string `json:"intervaltype"` + Isbackupvmexpunged bool `json:"isbackupvmexpunged"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Name string `json:"name"` diff --git a/cloudstack/BackupService_mock.go b/cloudstack/BackupService_mock.go index 66d4e347..12af665a 100644 --- a/cloudstack/BackupService_mock.go +++ b/cloudstack/BackupService_mock.go @@ -388,6 +388,27 @@ func (mr *MockBackupServiceIfaceMockRecorder) GetBackupRepositoryID(name any, op return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupRepositoryID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupRepositoryID), varargs...) } +// GetBackupScheduleByID mocks base method. +func (m *MockBackupServiceIface) GetBackupScheduleByID(id string, opts ...OptionFunc) (*BackupSchedule, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetBackupScheduleByID", varargs...) + ret0, _ := ret[0].(*BackupSchedule) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetBackupScheduleByID indicates an expected call of GetBackupScheduleByID. +func (mr *MockBackupServiceIfaceMockRecorder) GetBackupScheduleByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetBackupScheduleByID", reflect.TypeOf((*MockBackupServiceIface)(nil).GetBackupScheduleByID), varargs...) +} + // ImportBackupOffering mocks base method. func (m *MockBackupServiceIface) ImportBackupOffering(p *ImportBackupOfferingParams) (*ImportBackupOfferingResponse, error) { m.ctrl.T.Helper() @@ -676,17 +697,17 @@ func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupRepositoriesParams() } // NewListBackupScheduleParams mocks base method. -func (m *MockBackupServiceIface) NewListBackupScheduleParams(virtualmachineid string) *ListBackupScheduleParams { +func (m *MockBackupServiceIface) NewListBackupScheduleParams() *ListBackupScheduleParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewListBackupScheduleParams", virtualmachineid) + ret := m.ctrl.Call(m, "NewListBackupScheduleParams") ret0, _ := ret[0].(*ListBackupScheduleParams) return ret0 } // NewListBackupScheduleParams indicates an expected call of NewListBackupScheduleParams. -func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupScheduleParams(virtualmachineid any) *gomock.Call { +func (mr *MockBackupServiceIfaceMockRecorder) NewListBackupScheduleParams() *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupScheduleParams), virtualmachineid) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListBackupScheduleParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewListBackupScheduleParams)) } // NewListBackupsParams mocks base method. diff --git a/cloudstack/ConfigurationService.go b/cloudstack/ConfigurationService.go index 7e9cfd69..571b85cf 100644 --- a/cloudstack/ConfigurationService.go +++ b/cloudstack/ConfigurationService.go @@ -93,6 +93,7 @@ type ListCapabilitiesResponse struct { } type Capability struct { + Additionalconfigenabled bool `json:"additionalconfigenabled"` Allowusercreateprojects bool `json:"allowusercreateprojects"` Allowuserexpungerecovervm bool `json:"allowuserexpungerecovervm"` Allowuserexpungerecovervolume bool `json:"allowuserexpungerecovervolume"` @@ -1336,6 +1337,7 @@ func (s *ConfigurationService) UpdateStorageCapabilities(p *UpdateStorageCapabil type UpdateStorageCapabilitiesResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` diff --git a/cloudstack/HostService.go b/cloudstack/HostService.go index 78774b23..16f9009b 100644 --- a/cloudstack/HostService.go +++ b/cloudstack/HostService.go @@ -4767,6 +4767,10 @@ func (p *UpdateHostParams) toURLValues() url.Values { if v, found := p.p["annotation"]; found { u.Set("annotation", v.(string)) } + if v, found := p.p["cleanupexternaldetails"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanupexternaldetails", vv) + } if v, found := p.p["externaldetails"]; found { m := v.(map[string]string) for i, k := range getSortedKeysFromMap(m) { @@ -4839,6 +4843,27 @@ func (p *UpdateHostParams) GetAnnotation() (string, bool) { return value, ok } +func (p *UpdateHostParams) SetCleanupexternaldetails(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanupexternaldetails"] = v +} + +func (p *UpdateHostParams) ResetCleanupexternaldetails() { + if p.p != nil && p.p["cleanupexternaldetails"] != nil { + delete(p.p, "cleanupexternaldetails") + } +} + +func (p *UpdateHostParams) GetCleanupexternaldetails() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanupexternaldetails"].(bool) + return value, ok +} + func (p *UpdateHostParams) SetExternaldetails(v map[string]string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/InternalLBService.go b/cloudstack/InternalLBService.go index 3b7c0444..1e2c53ce 100644 --- a/cloudstack/InternalLBService.go +++ b/cloudstack/InternalLBService.go @@ -1102,6 +1102,7 @@ type InternalLoadBalancerVMHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -1250,6 +1251,7 @@ type StartInternalLoadBalancerVMResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -1423,5 +1425,6 @@ type StopInternalLoadBalancerVMResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } diff --git a/cloudstack/KubernetesService.go b/cloudstack/KubernetesService.go index 373ec6c1..0ce0afb0 100644 --- a/cloudstack/KubernetesService.go +++ b/cloudstack/KubernetesService.go @@ -397,6 +397,10 @@ func (p *CreateKubernetesClusterParams) toURLValues() url.Values { if v, found := p.p["domainid"]; found { u.Set("domainid", v.(string)) } + if v, found := p.p["enablecsi"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("enablecsi", vv) + } if v, found := p.p["etcdnodes"]; found { vv := strconv.FormatInt(v.(int64), 10) u.Set("etcdnodes", vv) @@ -688,6 +692,27 @@ func (p *CreateKubernetesClusterParams) GetDomainid() (string, bool) { return value, ok } +func (p *CreateKubernetesClusterParams) SetEnablecsi(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["enablecsi"] = v +} + +func (p *CreateKubernetesClusterParams) ResetEnablecsi() { + if p.p != nil && p.p["enablecsi"] != nil { + delete(p.p, "enablecsi") + } +} + +func (p *CreateKubernetesClusterParams) GetEnablecsi() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["enablecsi"].(bool) + return value, ok +} + func (p *CreateKubernetesClusterParams) SetEtcdnodes(v int64) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1065,6 +1090,7 @@ type CreateKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1096,6 +1122,7 @@ type CreateKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -1815,6 +1842,7 @@ type KubernetesCluster struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -1846,6 +1874,7 @@ type KubernetesCluster struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -2461,6 +2490,7 @@ type ScaleKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2492,6 +2522,7 @@ type ScaleKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -2592,6 +2623,7 @@ type StartKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2623,6 +2655,7 @@ type StartKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -2936,6 +2969,7 @@ type UpgradeKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -2967,6 +3001,7 @@ type UpgradeKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -3483,6 +3518,7 @@ type AddNodesToKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -3514,6 +3550,7 @@ type AddNodesToKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` @@ -3640,6 +3677,7 @@ type RemoveNodesFromKubernetesClusterResponse struct { Controlofferingname string `json:"controlofferingname"` Cpunumber string `json:"cpunumber"` Created string `json:"created"` + Csienabled bool `json:"csienabled"` Description string `json:"description"` Domain string `json:"domain"` Domainid string `json:"domainid"` @@ -3671,6 +3709,7 @@ type RemoveNodesFromKubernetesClusterResponse struct { Size int64 `json:"size"` State string `json:"state"` Templateid string `json:"templateid"` + Templatename string `json:"templatename"` Virtualmachines []*VirtualMachine `json:"virtualmachines"` Workerofferingid string `json:"workerofferingid"` Workerofferingname string `json:"workerofferingname"` diff --git a/cloudstack/LDAPService.go b/cloudstack/LDAPService.go index cc8af48c..b2ab0625 100644 --- a/cloudstack/LDAPService.go +++ b/cloudstack/LDAPService.go @@ -24,13 +24,14 @@ import ( "fmt" "net/url" "strconv" + "strings" ) type LDAPServiceIface interface { AddLdapConfiguration(p *AddLdapConfigurationParams) (*AddLdapConfigurationResponse, error) NewAddLdapConfigurationParams(hostname string, port int) *AddLdapConfigurationParams DeleteLdapConfiguration(p *DeleteLdapConfigurationParams) (*DeleteLdapConfigurationResponse, error) - NewDeleteLdapConfigurationParams(hostname string) *DeleteLdapConfigurationParams + NewDeleteLdapConfigurationParams() *DeleteLdapConfigurationParams ImportLdapUsers(p *ImportLdapUsersParams) (*ImportLdapUsersResponse, error) NewImportLdapUsersParams() *ImportLdapUsersParams LdapConfig(p *LdapConfigParams) (*LdapConfigResponse, error) @@ -43,6 +44,7 @@ type LDAPServiceIface interface { NewLinkDomainToLdapParams(accounttype int, domainid string, lDAPType string) *LinkDomainToLdapParams ListLdapConfigurations(p *ListLdapConfigurationsParams) (*ListLdapConfigurationsResponse, error) NewListLdapConfigurationsParams() *ListLdapConfigurationsParams + GetLdapConfigurationByID(id string, opts ...OptionFunc) (*LdapConfiguration, int, error) ListLdapUsers(p *ListLdapUsersParams) (*ListLdapUsersResponse, error) NewListLdapUsersParams() *ListLdapUsersParams SearchLdap(p *SearchLdapParams) (*SearchLdapResponse, error) @@ -162,6 +164,7 @@ func (s *LDAPService) AddLdapConfiguration(p *AddLdapConfigurationParams) (*AddL type AddLdapConfigurationResponse struct { Domainid string `json:"domainid"` Hostname string `json:"hostname"` + Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Port int `json:"port"` @@ -182,6 +185,9 @@ func (p *DeleteLdapConfigurationParams) toURLValues() url.Values { if v, found := p.p["hostname"]; found { u.Set("hostname", v.(string)) } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } if v, found := p.p["port"]; found { vv := strconv.Itoa(v.(int)) u.Set("port", vv) @@ -231,6 +237,27 @@ func (p *DeleteLdapConfigurationParams) GetHostname() (string, bool) { return value, ok } +func (p *DeleteLdapConfigurationParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *DeleteLdapConfigurationParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *DeleteLdapConfigurationParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + func (p *DeleteLdapConfigurationParams) SetPort(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -254,10 +281,9 @@ func (p *DeleteLdapConfigurationParams) GetPort() (int, bool) { // You should always use this function to get a new DeleteLdapConfigurationParams instance, // as then you are sure you have configured all required params -func (s *LDAPService) NewDeleteLdapConfigurationParams(hostname string) *DeleteLdapConfigurationParams { +func (s *LDAPService) NewDeleteLdapConfigurationParams() *DeleteLdapConfigurationParams { p := &DeleteLdapConfigurationParams{} p.p = make(map[string]interface{}) - p.p["hostname"] = hostname return p } @@ -279,6 +305,7 @@ func (s *LDAPService) DeleteLdapConfiguration(p *DeleteLdapConfigurationParams) type DeleteLdapConfigurationResponse struct { Domainid string `json:"domainid"` Hostname string `json:"hostname"` + Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Port int `json:"port"` @@ -1514,6 +1541,9 @@ func (p *ListLdapConfigurationsParams) toURLValues() url.Values { if v, found := p.p["hostname"]; found { u.Set("hostname", 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)) } @@ -1578,6 +1608,27 @@ func (p *ListLdapConfigurationsParams) GetHostname() (string, bool) { return value, ok } +func (p *ListLdapConfigurationsParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *ListLdapConfigurationsParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *ListLdapConfigurationsParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + func (p *ListLdapConfigurationsParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -1691,6 +1742,39 @@ func (s *LDAPService) NewListLdapConfigurationsParams() *ListLdapConfigurationsP return p } +// This is a courtesy helper function, which in some cases may not work as expected! +func (s *LDAPService) GetLdapConfigurationByID(id string, opts ...OptionFunc) (*LdapConfiguration, int, error) { + p := &ListLdapConfigurationsParams{} + 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.ListLdapConfigurations(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.LdapConfigurations[0], l.Count, nil + } + return nil, l.Count, fmt.Errorf("There is more then one result for LdapConfiguration UUID: %s!", id) +} + // Lists all LDAP configurations func (s *LDAPService) ListLdapConfigurations(p *ListLdapConfigurationsParams) (*ListLdapConfigurationsResponse, error) { resp, err := s.cs.newRequest("listLdapConfigurations", p.toURLValues()) @@ -1714,6 +1798,7 @@ type ListLdapConfigurationsResponse struct { type LdapConfiguration struct { Domainid string `json:"domainid"` Hostname string `json:"hostname"` + Id string `json:"id"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Port int `json:"port"` diff --git a/cloudstack/LDAPService_mock.go b/cloudstack/LDAPService_mock.go index 09b77d56..9dadf6ac 100644 --- a/cloudstack/LDAPService_mock.go +++ b/cloudstack/LDAPService_mock.go @@ -88,6 +88,27 @@ func (mr *MockLDAPServiceIfaceMockRecorder) DeleteLdapConfiguration(p any) *gomo return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "DeleteLdapConfiguration", reflect.TypeOf((*MockLDAPServiceIface)(nil).DeleteLdapConfiguration), p) } +// GetLdapConfigurationByID mocks base method. +func (m *MockLDAPServiceIface) GetLdapConfigurationByID(id string, opts ...OptionFunc) (*LdapConfiguration, int, error) { + m.ctrl.T.Helper() + varargs := []any{id} + for _, a := range opts { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "GetLdapConfigurationByID", varargs...) + ret0, _ := ret[0].(*LdapConfiguration) + ret1, _ := ret[1].(int) + ret2, _ := ret[2].(error) + return ret0, ret1, ret2 +} + +// GetLdapConfigurationByID indicates an expected call of GetLdapConfigurationByID. +func (mr *MockLDAPServiceIfaceMockRecorder) GetLdapConfigurationByID(id any, opts ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + varargs := append([]any{id}, opts...) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetLdapConfigurationByID", reflect.TypeOf((*MockLDAPServiceIface)(nil).GetLdapConfigurationByID), varargs...) +} + // ImportLdapUsers mocks base method. func (m *MockLDAPServiceIface) ImportLdapUsers(p *ImportLdapUsersParams) (*ImportLdapUsersResponse, error) { m.ctrl.T.Helper() @@ -208,17 +229,17 @@ func (mr *MockLDAPServiceIfaceMockRecorder) NewAddLdapConfigurationParams(hostna } // NewDeleteLdapConfigurationParams mocks base method. -func (m *MockLDAPServiceIface) NewDeleteLdapConfigurationParams(hostname string) *DeleteLdapConfigurationParams { +func (m *MockLDAPServiceIface) NewDeleteLdapConfigurationParams() *DeleteLdapConfigurationParams { m.ctrl.T.Helper() - ret := m.ctrl.Call(m, "NewDeleteLdapConfigurationParams", hostname) + ret := m.ctrl.Call(m, "NewDeleteLdapConfigurationParams") ret0, _ := ret[0].(*DeleteLdapConfigurationParams) return ret0 } // NewDeleteLdapConfigurationParams indicates an expected call of NewDeleteLdapConfigurationParams. -func (mr *MockLDAPServiceIfaceMockRecorder) NewDeleteLdapConfigurationParams(hostname any) *gomock.Call { +func (mr *MockLDAPServiceIfaceMockRecorder) NewDeleteLdapConfigurationParams() *gomock.Call { mr.mock.ctrl.T.Helper() - return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteLdapConfigurationParams", reflect.TypeOf((*MockLDAPServiceIface)(nil).NewDeleteLdapConfigurationParams), hostname) + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewDeleteLdapConfigurationParams", reflect.TypeOf((*MockLDAPServiceIface)(nil).NewDeleteLdapConfigurationParams)) } // NewImportLdapUsersParams mocks base method. diff --git a/cloudstack/LoadBalancerService.go b/cloudstack/LoadBalancerService.go index 8452cf05..c66a8c0c 100644 --- a/cloudstack/LoadBalancerService.go +++ b/cloudstack/LoadBalancerService.go @@ -123,6 +123,10 @@ func (p *AssignCertToLoadBalancerParams) toURLValues() url.Values { if v, found := p.p["certid"]; found { u.Set("certid", v.(string)) } + if v, found := p.p["forced"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forced", vv) + } if v, found := p.p["lbruleid"]; found { u.Set("lbruleid", v.(string)) } @@ -150,6 +154,27 @@ func (p *AssignCertToLoadBalancerParams) GetCertid() (string, bool) { return value, ok } +func (p *AssignCertToLoadBalancerParams) SetForced(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forced"] = v +} + +func (p *AssignCertToLoadBalancerParams) ResetForced() { + if p.p != nil && p.p["forced"] != nil { + delete(p.p, "forced") + } +} + +func (p *AssignCertToLoadBalancerParams) GetForced() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forced"].(bool) + return value, ok +} + func (p *AssignCertToLoadBalancerParams) SetLbruleid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -5913,6 +5938,7 @@ type StopNetScalerVpxResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -6594,6 +6620,10 @@ func (p *UpdateLoadBalancerRuleParams) toURLValues() url.Values { if v, found := p.p["algorithm"]; found { u.Set("algorithm", v.(string)) } + if v, found := p.p["cidrlist"]; found { + vv := strings.Join(v.([]string), ",") + u.Set("cidrlist", vv) + } if v, found := p.p["customid"]; found { u.Set("customid", v.(string)) } @@ -6637,6 +6667,27 @@ func (p *UpdateLoadBalancerRuleParams) GetAlgorithm() (string, bool) { return value, ok } +func (p *UpdateLoadBalancerRuleParams) SetCidrlist(v []string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cidrlist"] = v +} + +func (p *UpdateLoadBalancerRuleParams) ResetCidrlist() { + if p.p != nil && p.p["cidrlist"] != nil { + delete(p.p, "cidrlist") + } +} + +func (p *UpdateLoadBalancerRuleParams) GetCidrlist() ([]string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cidrlist"].([]string) + return value, ok +} + func (p *UpdateLoadBalancerRuleParams) SetCustomid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/MetricsService.go b/cloudstack/MetricsService.go index 77c20472..ea4e3679 100644 --- a/cloudstack/MetricsService.go +++ b/cloudstack/MetricsService.go @@ -70,19 +70,20 @@ type ListInfrastructureResponse struct { } type Infrastructure struct { - Alerts int `json:"alerts"` - Clusters int `json:"clusters"` - Cpusockets int `json:"cpusockets"` - Hosts int `json:"hosts"` - Ilbvms int `json:"ilbvms"` - Imagestores int `json:"imagestores"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Managementservers int `json:"managementservers"` - Objectstores int `json:"objectstores"` - Pods int `json:"pods"` - Routers int `json:"routers"` - Storagepools int `json:"storagepools"` - Systemvms int `json:"systemvms"` - Zones int `json:"zones"` + Alerts int `json:"alerts"` + Backuprepositories int `json:"backuprepositories"` + Clusters int `json:"clusters"` + Cpusockets int `json:"cpusockets"` + Hosts int `json:"hosts"` + Ilbvms int `json:"ilbvms"` + Imagestores int `json:"imagestores"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Managementservers int `json:"managementservers"` + Objectstores int `json:"objectstores"` + Pods int `json:"pods"` + Routers int `json:"routers"` + Storagepools int `json:"storagepools"` + Systemvms int `json:"systemvms"` + Zones int `json:"zones"` } diff --git a/cloudstack/NetworkService.go b/cloudstack/NetworkService.go index 10b35bf5..96f1a2e1 100644 --- a/cloudstack/NetworkService.go +++ b/cloudstack/NetworkService.go @@ -70,7 +70,7 @@ type NetworkServiceIface interface { GetNetworkServiceProviderID(name string, opts ...OptionFunc) (string, int, error) ListNetworks(p *ListNetworksParams) (*ListNetworksResponse, error) NewListNetworksParams() *ListNetworksParams - GetNetworkID(keyword string, opts ...OptionFunc) (string, int, error) + GetNetworkID(name string, opts ...OptionFunc) (string, int, error) GetNetworkByName(name string, opts ...OptionFunc) (*Network, int, error) GetNetworkByID(id string, opts ...OptionFunc) (*Network, int, error) ListNiciraNvpDeviceNetworks(p *ListNiciraNvpDeviceNetworksParams) (*ListNiciraNvpDeviceNetworksResponse, error) @@ -4143,6 +4143,9 @@ func (p *ListNetworksParams) toURLValues() url.Values { 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["networkfilter"]; found { u.Set("networkfilter", v.(string)) } @@ -4460,6 +4463,27 @@ func (p *ListNetworksParams) GetListall() (bool, bool) { return value, ok } +func (p *ListNetworksParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *ListNetworksParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *ListNetworksParams) GetName() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["name"].(string) + return value, ok +} + func (p *ListNetworksParams) SetNetworkfilter(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -4826,11 +4850,11 @@ func (s *NetworkService) NewListNetworksParams() *ListNetworksParams { } // This is a courtesy helper function, which in some cases may not work as expected! -func (s *NetworkService) GetNetworkID(keyword string, opts ...OptionFunc) (string, int, error) { +func (s *NetworkService) GetNetworkID(name string, opts ...OptionFunc) (string, int, error) { p := &ListNetworksParams{} p.p = make(map[string]interface{}) - p.p["keyword"] = keyword + p.p["name"] = name for _, fn := range append(s.cs.options, opts...) { if err := fn(s.cs, p); err != nil { @@ -4844,7 +4868,7 @@ func (s *NetworkService) GetNetworkID(keyword string, opts ...OptionFunc) (strin } if l.Count == 0 { - return "", l.Count, fmt.Errorf("No match found for %s: %+v", keyword, l) + return "", l.Count, fmt.Errorf("No match found for %s: %+v", name, l) } if l.Count == 1 { @@ -4853,12 +4877,12 @@ func (s *NetworkService) GetNetworkID(keyword string, opts ...OptionFunc) (strin if l.Count > 1 { for _, v := range l.Networks { - if v.Name == keyword { + if v.Name == name { return v.Id, l.Count, nil } } } - return "", l.Count, fmt.Errorf("Could not find an exact match for %s: %+v", keyword, l) + 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! diff --git a/cloudstack/NetworkService_mock.go b/cloudstack/NetworkService_mock.go index afad806d..fb501275 100644 --- a/cloudstack/NetworkService_mock.go +++ b/cloudstack/NetworkService_mock.go @@ -413,9 +413,9 @@ func (mr *MockNetworkServiceIfaceMockRecorder) GetNetworkByName(name any, opts . } // GetNetworkID mocks base method. -func (m *MockNetworkServiceIface) GetNetworkID(keyword string, opts ...OptionFunc) (string, int, error) { +func (m *MockNetworkServiceIface) GetNetworkID(name string, opts ...OptionFunc) (string, int, error) { m.ctrl.T.Helper() - varargs := []any{keyword} + varargs := []any{name} for _, a := range opts { varargs = append(varargs, a) } @@ -427,9 +427,9 @@ func (m *MockNetworkServiceIface) GetNetworkID(keyword string, opts ...OptionFun } // GetNetworkID indicates an expected call of GetNetworkID. -func (mr *MockNetworkServiceIfaceMockRecorder) GetNetworkID(keyword any, opts ...any) *gomock.Call { +func (mr *MockNetworkServiceIfaceMockRecorder) GetNetworkID(name any, opts ...any) *gomock.Call { mr.mock.ctrl.T.Helper() - varargs := append([]any{keyword}, opts...) + varargs := append([]any{name}, opts...) return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "GetNetworkID", reflect.TypeOf((*MockNetworkServiceIface)(nil).GetNetworkID), varargs...) } diff --git a/cloudstack/PoolService.go b/cloudstack/PoolService.go index 885a44c7..9ea2f50c 100644 --- a/cloudstack/PoolService.go +++ b/cloudstack/PoolService.go @@ -458,6 +458,7 @@ func (s *PoolService) CreateStoragePool(p *CreateStoragePoolParams) (*CreateStor type CreateStoragePoolResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -749,6 +750,7 @@ func (s *PoolService) FindStoragePoolsForMigration(p *FindStoragePoolsForMigrati type FindStoragePoolsForMigrationResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -1350,6 +1352,7 @@ type ListStoragePoolsResponse struct { type StoragePool struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -1468,6 +1471,7 @@ func (s *PoolService) SyncStoragePool(p *SyncStoragePoolParams) (*SyncStoragePoo type SyncStoragePoolResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -1766,6 +1770,7 @@ func (s *PoolService) UpdateStoragePool(p *UpdateStoragePoolParams) (*UpdateStor type UpdateStoragePoolResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` diff --git a/cloudstack/RouterService.go b/cloudstack/RouterService.go index 9d47790a..ed27a8c0 100644 --- a/cloudstack/RouterService.go +++ b/cloudstack/RouterService.go @@ -204,6 +204,7 @@ type ChangeServiceForRouterResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -590,6 +591,7 @@ type DestroyRouterResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -1408,6 +1410,7 @@ type RouterHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -1815,6 +1818,7 @@ type RebootRouterResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -1963,6 +1967,7 @@ type StartRouterResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } @@ -2136,5 +2141,6 @@ type StopRouterResponseHealthcheckresults struct { Checktype string `json:"checktype"` Details string `json:"details"` Lastupdated string `json:"lastupdated"` + Status string `json:"status"` Success bool `json:"success"` } diff --git a/cloudstack/ServiceOfferingService.go b/cloudstack/ServiceOfferingService.go index 61238ab8..372b4ed6 100644 --- a/cloudstack/ServiceOfferingService.go +++ b/cloudstack/ServiceOfferingService.go @@ -2353,6 +2353,10 @@ func (p *UpdateServiceOfferingParams) toURLValues() url.Values { if p.p == nil { return u } + if v, found := p.p["cleanupexternaldetails"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("cleanupexternaldetails", vv) + } if v, found := p.p["displaytext"]; found { u.Set("displaytext", v.(string)) } @@ -2395,6 +2399,27 @@ func (p *UpdateServiceOfferingParams) toURLValues() url.Values { return u } +func (p *UpdateServiceOfferingParams) SetCleanupexternaldetails(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["cleanupexternaldetails"] = v +} + +func (p *UpdateServiceOfferingParams) ResetCleanupexternaldetails() { + if p.p != nil && p.p["cleanupexternaldetails"] != nil { + delete(p.p, "cleanupexternaldetails") + } +} + +func (p *UpdateServiceOfferingParams) GetCleanupexternaldetails() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["cleanupexternaldetails"].(bool) + return value, ok +} + func (p *UpdateServiceOfferingParams) SetDisplaytext(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/SnapshotService.go b/cloudstack/SnapshotService.go index b1a148a9..ab11f368 100644 --- a/cloudstack/SnapshotService.go +++ b/cloudstack/SnapshotService.go @@ -1394,6 +1394,7 @@ type CreateSnapshotPolicyResponse struct { Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` Zone []interface{} `json:"zone"` } @@ -2042,6 +2043,12 @@ func (p *ListSnapshotPoliciesParams) toURLValues() 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["fordisplay"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("fordisplay", vv) @@ -2049,9 +2056,17 @@ func (p *ListSnapshotPoliciesParams) toURLValues() url.Values { 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["page"]; found { vv := strconv.Itoa(v.(int)) u.Set("page", vv) @@ -2060,12 +2075,57 @@ func (p *ListSnapshotPoliciesParams) toURLValues() url.Values { 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["volumeid"]; found { u.Set("volumeid", v.(string)) } return u } +func (p *ListSnapshotPoliciesParams) SetAccount(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["account"] = v +} + +func (p *ListSnapshotPoliciesParams) ResetAccount() { + if p.p != nil && p.p["account"] != nil { + delete(p.p, "account") + } +} + +func (p *ListSnapshotPoliciesParams) GetAccount() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["account"].(string) + return value, ok +} + +func (p *ListSnapshotPoliciesParams) SetDomainid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["domainid"] = v +} + +func (p *ListSnapshotPoliciesParams) ResetDomainid() { + if p.p != nil && p.p["domainid"] != nil { + delete(p.p, "domainid") + } +} + +func (p *ListSnapshotPoliciesParams) GetDomainid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["domainid"].(string) + return value, ok +} + func (p *ListSnapshotPoliciesParams) SetFordisplay(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2108,6 +2168,27 @@ func (p *ListSnapshotPoliciesParams) GetId() (string, bool) { return value, ok } +func (p *ListSnapshotPoliciesParams) SetIsrecursive(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["isrecursive"] = v +} + +func (p *ListSnapshotPoliciesParams) ResetIsrecursive() { + if p.p != nil && p.p["isrecursive"] != nil { + delete(p.p, "isrecursive") + } +} + +func (p *ListSnapshotPoliciesParams) GetIsrecursive() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["isrecursive"].(bool) + return value, ok +} + func (p *ListSnapshotPoliciesParams) SetKeyword(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2129,6 +2210,27 @@ func (p *ListSnapshotPoliciesParams) GetKeyword() (string, bool) { return value, ok } +func (p *ListSnapshotPoliciesParams) SetListall(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["listall"] = v +} + +func (p *ListSnapshotPoliciesParams) ResetListall() { + if p.p != nil && p.p["listall"] != nil { + delete(p.p, "listall") + } +} + +func (p *ListSnapshotPoliciesParams) GetListall() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["listall"].(bool) + return value, ok +} + func (p *ListSnapshotPoliciesParams) SetPage(v int) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2171,6 +2273,27 @@ func (p *ListSnapshotPoliciesParams) GetPagesize() (int, bool) { return value, ok } +func (p *ListSnapshotPoliciesParams) SetProjectid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["projectid"] = v +} + +func (p *ListSnapshotPoliciesParams) ResetProjectid() { + if p.p != nil && p.p["projectid"] != nil { + delete(p.p, "projectid") + } +} + +func (p *ListSnapshotPoliciesParams) GetProjectid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["projectid"].(string) + return value, ok +} + func (p *ListSnapshotPoliciesParams) SetVolumeid(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -2266,6 +2389,7 @@ type SnapshotPolicy struct { Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` Zone []interface{} `json:"zone"` } @@ -3943,5 +4067,6 @@ type UpdateSnapshotPolicyResponse struct { Tags []Tags `json:"tags"` Timezone string `json:"timezone"` Volumeid string `json:"volumeid"` + Volumename string `json:"volumename"` Zone []interface{} `json:"zone"` } diff --git a/cloudstack/StoragePoolService.go b/cloudstack/StoragePoolService.go index ea964ada..9a1c0ff2 100644 --- a/cloudstack/StoragePoolService.go +++ b/cloudstack/StoragePoolService.go @@ -142,6 +142,7 @@ func (s *StoragePoolService) CancelStorageMaintenance(p *CancelStorageMaintenanc type CancelStorageMaintenanceResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -391,6 +392,7 @@ func (s *StoragePoolService) EnableStorageMaintenance(p *EnableStorageMaintenanc type EnableStorageMaintenanceResponse struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` @@ -2215,6 +2217,7 @@ type ListStoragePoolsMetricsResponse struct { type StoragePoolsMetric struct { Allocatediops int64 `json:"allocatediops"` + Capacitybytes int64 `json:"capacitybytes"` Capacityiops int64 `json:"capacityiops"` Clusterid string `json:"clusterid"` Clustername string `json:"clustername"` diff --git a/cloudstack/SystemVMService.go b/cloudstack/SystemVMService.go index f5d5ad25..f024d065 100644 --- a/cloudstack/SystemVMService.go +++ b/cloudstack/SystemVMService.go @@ -1112,12 +1112,29 @@ type ListSystemVmsUsageHistoryResponse struct { } type SystemVmsUsageHistory struct { - Displayname string `json:"displayname"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Stats []string `json:"stats"` + Displayname string `json:"displayname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Stats []SystemVmsUsageHistoryStats `json:"stats"` +} + +type SystemVmsUsageHistoryStats struct { + Cpuused string `json:"cpuused"` + Diskiopstotal int64 `json:"diskiopstotal"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Memoryintfreekbs int64 `json:"memoryintfreekbs"` + Memorykbs int64 `json:"memorykbs"` + Memorytargetkbs int64 `json:"memorytargetkbs"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Networkread string `json:"networkread"` + Networkwrite string `json:"networkwrite"` + Timestamp string `json:"timestamp"` } type MigrateSystemVmParams struct { diff --git a/cloudstack/TemplateService.go b/cloudstack/TemplateService.go index 9a1c4906..e9f90712 100644 --- a/cloudstack/TemplateService.go +++ b/cloudstack/TemplateService.go @@ -1383,6 +1383,9 @@ func (p *GetUploadParamsForTemplateParams) toURLValues() url.Values { if v, found := p.p["templatetag"]; found { u.Set("templatetag", v.(string)) } + if v, found := p.p["templatetype"]; found { + u.Set("templatetype", v.(string)) + } if v, found := p.p["zoneid"]; found { u.Set("zoneid", v.(string)) } @@ -1872,6 +1875,27 @@ func (p *GetUploadParamsForTemplateParams) GetTemplatetag() (string, bool) { return value, ok } +func (p *GetUploadParamsForTemplateParams) SetTemplatetype(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["templatetype"] = v +} + +func (p *GetUploadParamsForTemplateParams) ResetTemplatetype() { + if p.p != nil && p.p["templatetype"] != nil { + delete(p.p, "templatetype") + } +} + +func (p *GetUploadParamsForTemplateParams) GetTemplatetype() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["templatetype"].(string) + return value, ok +} + func (p *GetUploadParamsForTemplateParams) SetZoneid(v string) { if p.p == nil { p.p = make(map[string]interface{}) diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index 04d30920..ecdbdd5e 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -11455,12 +11455,29 @@ type ListVirtualMachinesUsageHistoryResponse struct { } type VirtualMachinesUsageHistory struct { - Displayname string `json:"displayname"` - Id string `json:"id"` - JobID string `json:"jobid"` - Jobstatus int `json:"jobstatus"` - Name string `json:"name"` - Stats []string `json:"stats"` + Displayname string `json:"displayname"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Name string `json:"name"` + Stats []VirtualMachinesUsageHistoryStats `json:"stats"` +} + +type VirtualMachinesUsageHistoryStats struct { + Cpuused string `json:"cpuused"` + Diskiopstotal int64 `json:"diskiopstotal"` + Diskioread int64 `json:"diskioread"` + Diskiowrite int64 `json:"diskiowrite"` + Diskkbsread int64 `json:"diskkbsread"` + Diskkbswrite int64 `json:"diskkbswrite"` + Memoryintfreekbs int64 `json:"memoryintfreekbs"` + Memorykbs int64 `json:"memorykbs"` + Memorytargetkbs int64 `json:"memorytargetkbs"` + Networkkbsread int64 `json:"networkkbsread"` + Networkkbswrite int64 `json:"networkkbswrite"` + Networkread string `json:"networkread"` + Networkwrite string `json:"networkwrite"` + Timestamp string `json:"timestamp"` } type ImportVmParams struct { @@ -11516,6 +11533,13 @@ func (p *ImportVmParams) toURLValues() url.Values { if v, found := p.p["existingvcenterid"]; found { u.Set("existingvcenterid", v.(string)) } + if v, found := p.p["extraparams"]; found { + u.Set("extraparams", v.(string)) + } + if v, found := p.p["forceconverttopool"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("forceconverttopool", vv) + } if v, found := p.p["forced"]; found { vv := strconv.FormatBool(v.(bool)) u.Set("forced", vv) @@ -11866,6 +11890,48 @@ func (p *ImportVmParams) GetExistingvcenterid() (string, bool) { return value, ok } +func (p *ImportVmParams) SetExtraparams(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["extraparams"] = v +} + +func (p *ImportVmParams) ResetExtraparams() { + if p.p != nil && p.p["extraparams"] != nil { + delete(p.p, "extraparams") + } +} + +func (p *ImportVmParams) GetExtraparams() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["extraparams"].(string) + return value, ok +} + +func (p *ImportVmParams) SetForceconverttopool(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forceconverttopool"] = v +} + +func (p *ImportVmParams) ResetForceconverttopool() { + if p.p != nil && p.p["forceconverttopool"] != nil { + delete(p.p, "forceconverttopool") + } +} + +func (p *ImportVmParams) GetForceconverttopool() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forceconverttopool"].(bool) + return value, ok +} + func (p *ImportVmParams) SetForced(v bool) { if p.p == nil { p.p = make(map[string]interface{}) @@ -12602,12 +12668,61 @@ func (p *UnmanageVirtualMachineParams) toURLValues() 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["hostid"]; found { + u.Set("hostid", v.(string)) + } if v, found := p.p["id"]; found { u.Set("id", v.(string)) } return u } +func (p *UnmanageVirtualMachineParams) SetForced(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["forced"] = v +} + +func (p *UnmanageVirtualMachineParams) ResetForced() { + if p.p != nil && p.p["forced"] != nil { + delete(p.p, "forced") + } +} + +func (p *UnmanageVirtualMachineParams) GetForced() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["forced"].(bool) + return value, ok +} + +func (p *UnmanageVirtualMachineParams) SetHostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["hostid"] = v +} + +func (p *UnmanageVirtualMachineParams) ResetHostid() { + if p.p != nil && p.p["hostid"] != nil { + delete(p.p, "hostid") + } +} + +func (p *UnmanageVirtualMachineParams) GetHostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["hostid"].(string) + return value, ok +} + func (p *UnmanageVirtualMachineParams) SetId(v string) { if p.p == nil { p.p = make(map[string]interface{}) @@ -12675,6 +12790,7 @@ func (s *VirtualMachineService) UnmanageVirtualMachine(p *UnmanageVirtualMachine type UnmanageVirtualMachineResponse struct { Details string `json:"details"` + Hostid string `json:"hostid"` JobID string `json:"jobid"` Jobstatus int `json:"jobstatus"` Success bool `json:"success"` diff --git a/generate/listApis.json b/generate/listApis.json index 017bfead..a8c045f6 100644 --- a/generate/listApis.json +++ b/generate/listApis.json @@ -6,26 +6,25 @@ "name": "createVPCOffering", "params": [ { - "description": "desired service capabilities as part of vpc offering", + "description": "services supported by the vpc offering", "length": 255, - "name": "servicecapabilitylist", + "name": "supportedservices", "required": false, - "since": "4.4", - "type": "map" + "type": "list" }, { - "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "description": "desired service capabilities as part of vpc offering", "length": 255, - "name": "routingmode", + "name": "servicecapabilitylist", "required": false, - "since": "4.20.0", - "type": "string" + "since": "4.4", + "type": "map" }, { - "description": "the display text of the vpc offering, defaults to the 'name'", + "description": "the name of the vpc offering", "length": 255, - "name": "displaytext", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -37,26 +36,12 @@ "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", - "required": false, - "type": "map" - }, - { - "description": "the name of the vpc offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "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", + "description": "true if network offering for NSX VPC offering supports Load balancer service.", "length": 255, - "name": "internetprotocol", + "name": "nsxsupportlb", "required": false, - "since": "4.17.0", - "type": "string" + "since": "4.20.0", + "type": "boolean" }, { "description": "set to true if the offering is to be enabled during creation. Default is false", @@ -75,27 +60,19 @@ "type": "uuid" }, { - "description": "services supported by the vpc offering", - "length": 255, - "name": "supportedservices", - "required": false, - "type": "list" - }, - { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "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": "networkmode", + "name": "internetprotocol", "required": false, - "since": "4.20.0", + "since": "4.17.0", "type": "string" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "since": "4.13", "type": "list" }, { @@ -115,70 +92,47 @@ "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, + "since": "4.13", "type": "list" }, { - "description": "true if network offering for NSX VPC offering supports Load balancer service.", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "nsxsupportlb", + "name": "networkmode", "required": false, "since": "4.20.0", - "type": "boolean" - } - ], - "related": "updateVPCOffering,listVPCOfferings", - "response": [ - { - "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 choosing AS numbers", - "name": "specifyasnumber", - "type": "boolean" - }, - { - "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", "type": "string" }, - {}, { - "description": "the name of the vpc offering", - "name": "name", - "type": "string" + "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", + "required": false, + "type": "map" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "the display text of the vpc offering, defaults to the 'name'", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the routing mode for the VPC offering. Supported types are: Static or Dynamic.", + "length": 255, + "name": "routingmode", + "required": false, + "since": "4.20.0", "type": "string" - }, + } + ], + "related": "updateVPCOffering,listVPCOfferings", + "response": [ { "description": "the list of supported services", "name": "service", @@ -188,23 +142,23 @@ "name": "provider", "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "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": "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": "state of the network provider", + "name": "state", "type": "string" }, { @@ -213,13 +167,13 @@ "type": "boolean" }, { - "description": "state of the network provider", - "name": "state", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], @@ -229,11 +183,6 @@ "description": "the list of capabilities", "name": "capability", "response": [ - { - "description": "the capability name", - "name": "name", - "type": "string" - }, { "description": "the capability value", "name": "value", @@ -243,6 +192,11 @@ "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" @@ -256,13 +210,29 @@ "type": "list" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, + {}, { - "description": "true if vpc offering can be used by NSX networks only", - "name": "fornsx", + "description": "the name of the vpc offering", + "name": "name", + "type": "string" + }, + { + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "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": "true if vpc offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -271,9 +241,14 @@ "type": "string" }, { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" }, { "description": "the date this vpc offering was created", @@ -281,26 +256,51 @@ "type": "date" }, { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", + "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" + }, { "description": "state of the vpc offering. Can be Disabled/Enabled", "name": "state", "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": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "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": " indicates if the vpc offering supports distributed router for one-hop forwarding", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" }, - {}, { "description": "the internet protocol of the vpc offering", "name": "internetprotocol", @@ -314,25 +314,19 @@ "name": "ldapCreateAccount", "params": [ { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "Creates the user under the specified domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" - }, - { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, - "type": "string" + "type": "uuid" }, { - "description": "User UUID, required for adding account from external provisioning system", + "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "userid", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { "description": "details for account used to store specific parameters", @@ -341,13 +335,6 @@ "required": false, "type": "map" }, - { - "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": "Network domain for the account's networks", "length": 255, @@ -356,24 +343,23 @@ "type": "string" }, { - "description": "Creates the user under the specified domain.", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "Account UUID, required for adding account from external provisioning system", "length": 255, - "name": "timezone", + "name": "accountid", "required": false, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "accountid", + "name": "timezone", "required": false, "type": "string" }, @@ -384,64 +370,77 @@ "related": "createRole,importRole,listRoles,updateRole", "required": false, "type": "uuid" + }, + { + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, + "type": "string" } ], "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "response": [ - {}, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "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 buckets stored by this account", - "name": "buckettotal", - "type": "long" + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", + "type": "string" }, { - "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 account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { @@ -450,68 +449,83 @@ "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "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 total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "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 networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { @@ -520,19 +534,24 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the date when this account was created", + "name": "created", + "type": "date" + }, + { + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the id of the account", + "name": "id", + "type": "string" }, { "description": "the total number of snapshots available for this account", @@ -540,60 +559,85 @@ "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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", "type": "long" }, { - "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": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of gpus the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "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 owned by account", - "name": "cputotal", - "type": "long" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "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 object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "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 number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, { "description": "the list of users associated with account", "name": "user", @@ -604,79 +648,69 @@ "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "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", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", - "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 firstname", - "name": "firstname", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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", + "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 domain ID of the user", + "name": "domainid", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "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 date and time the user account was created", @@ -684,19 +718,19 @@ "type": "date" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the api key of the user", @@ -704,91 +738,93 @@ "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 is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the secret key of the user", + "name": "secretkey", + "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" } ], "type": "list" }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, { "description": "the total number of backups stored by this account", "name": "backuptotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the name of the account", - "name": "name", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, + {}, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, + {}, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" + "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 total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { @@ -797,58 +833,48 @@ "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "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", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "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 list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { @@ -857,9 +883,9 @@ "type": "string" }, { - "description": "the id of the account", - "name": "id", - "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 that can be deployed by this account", @@ -867,45 +893,19 @@ "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - {}, - { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "the state of the account", - "name": "state", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "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 templates which can be created by this account", - "name": "templatelimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" } ], "since": "4.2.0" @@ -916,74 +916,93 @@ "name": "copyIso", "params": [ { - "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": "Template ID.", "length": 255, - "name": "destzoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "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": "ID of the zone the template is being copied to.", + "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": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "Template ID.", + "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": "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" + "name": "destzoneids", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "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" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,copyTemplate,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "description": "the date this template was created", - "name": "created", - "type": "date" + "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": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { "description": "true if the template is managed across all Zones, false otherwise", "name": "crossZones", "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 date this template was removed", - "name": "removed", - "type": "date" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "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 template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -992,38 +1011,40 @@ "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the size of the template", + "name": "size", "type": "long" }, { - "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, + {}, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "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 the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { @@ -1032,54 +1053,85 @@ "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": "the template ID", - "name": "id", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "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 requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "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": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "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 ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + {}, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "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 reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the name of userdata linked to this template", @@ -1087,33 +1139,42 @@ "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, - {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", - "type": "boolean" + "description": "the name of the zone for this template", + "name": "zonename", + "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 tag of this template", + "name": "templatetag", + "type": "string" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", + "type": "string" + }, + { + "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": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -1122,8 +1183,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -1132,18 +1193,23 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -1152,72 +1218,56 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" - }, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the template name", + "name": "name", "type": "string" }, - {}, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "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 account name to which the template belongs", - "name": "account", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { @@ -1225,85 +1275,35 @@ "name": "ispublic", "type": "boolean" }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, { "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", - "name": "userdatapolicy", - "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 name", - "name": "name", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "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": "checksum of the template", - "name": "checksum", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "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" } ] }, @@ -1322,18 +1322,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -1343,7 +1342,8 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ] }, { @@ -1351,13 +1351,6 @@ "isasync": false, "name": "listVsphereStoragePolicyCompatiblePools", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "ID of the storage policy", "length": 255, @@ -1369,10 +1362,18 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "ID of the zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -1381,95 +1382,89 @@ "type": "string" }, { - "description": "ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "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 date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the storage pool", + "name": "name", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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 tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "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 Zone name of the storage pool", - "name": "zonename", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, - {}, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { @@ -1478,43 +1473,54 @@ "type": "boolean" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, + {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "the pool's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "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" }, { @@ -1523,50 +1529,49 @@ "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, - {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "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": "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": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" } ] }, @@ -1575,14 +1580,6 @@ "isasync": true, "name": "rebootSystemVm", "params": [ - { - "description": "The ID of the system virtual machine", - "length": 255, - "name": "id", - "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", - "required": true, - "type": "uuid" - }, { "description": "Force reboot the system VM (System VM is Stopped and then Started)", "length": 255, @@ -1590,217 +1587,225 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "The ID of the system virtual machine", + "length": 255, + "name": "id", + "related": "destroySystemVm,listSystemVms,migrateSystemVm,rebootSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "required": true, + "type": "uuid" } ], "related": "destroySystemVm,listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "CPU arch of the system VM", - "name": "arch", - "type": "string" - }, - { - "description": "the template ID for the system VM", - "name": "templateid", + "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", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the system VM type", + "name": "systemvmtype", "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 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", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { "description": "the gateway for the system VM", "name": "gateway", "type": "string" }, + {}, { "description": "the state of the system VM", "name": "state", "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 ID for the system VM", + "name": "zoneid", + "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the network domain for the system VM", + "name": "networkdomain", "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 name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "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" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the host ID for the system VM", + "name": "hostid", "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": "guest vlan range", "name": "guestvlan", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "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 public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "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 agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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 public netmask for the system VM", + "name": "publicnetmask", "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 link local IP address for the system vm", - "name": "linklocalip", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, - {}, { - "description": "the name of the system VM", - "name": "name", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" - } + }, + {} ] }, { @@ -1816,6 +1821,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "list dedicated zones by affinity group", "length": 255, @@ -1846,13 +1858,6 @@ "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the name of the account associated with the zone. Must be used with domainId.", "length": 255, @@ -1863,14 +1868,29 @@ ], "related": "dedicateZone", "response": [ + { + "description": "the Name of the Zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Name of the Zone", - "name": "zonename", + "description": "the Dedication Affinity Group ID of the zone", + "name": "affinitygroupid", "type": "string" }, {}, @@ -1879,31 +1899,16 @@ "name": "accountid", "type": "string" }, + {}, { "description": "the ID of the Zone", "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 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" } ] }, @@ -1923,51 +1928,51 @@ "related": "", "response": [ { - "description": "available iops of the pool", - "name": "maxiops", - "type": "long" - }, - { - "description": "the name of the storage pool", - "name": "name", + "description": "controller of the pool", + "name": "controllerid", "type": "string" }, { - "description": "the current available space of the pool", - "name": "size", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "controller of the pool", - "name": "controllerid", + "description": "default gateway of the pool", + "name": "gateway", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", - "type": "string" + "description": "the current available space of the pool", + "name": "size", + "type": "long" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, {}, + {}, { "description": "the state of the storage pool", "name": "state", "type": "string" }, { - "description": "default gateway of the pool", - "name": "gateway", + "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": "available iops of the pool", + "name": "maxiops", + "type": "long" + }, + { + "description": "the name of the storage pool", + "name": "name", + "type": "string" } ] }, @@ -1995,56 +2000,44 @@ ], "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer,changeBgpPeersForVpc", "response": [ - {}, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", + "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", - "name": "asnumber", - "type": "long" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "description": "the domain name of the bgp peer", - "name": "domain", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "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", + "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": "password of bgp peer", "name": "password", "type": "string" }, - {}, - { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { @@ -2052,30 +2045,42 @@ "name": "zoneid", "type": "string" }, - { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" - }, { "description": "IPv4 address of bgp peer", "name": "ipaddress", "type": "string" }, + {}, { - "description": "id of the bgp peer", - "name": "id", + "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": "AS number of bgp peer", + "name": "asnumber", + "type": "long" + }, + {}, + { + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "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": "date when this bgp peer was created.", + "name": "created", + "type": "date" } ], "since": "4.20.0" @@ -2085,13 +2090,6 @@ "isasync": false, "name": "listTungstenFabricLBHealthMonitor", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -2099,24 +2097,52 @@ "required": false, "type": "string" }, + { + "description": "the ID of lb rule", + "length": 255, + "name": "lbruleid", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the ID of lb rule", + "description": "", "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "updateTungstenFabricLBHealthMonitor", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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 type", + "name": "type", + "type": "string" + }, { "description": "the health monitor timeout", "name": "timeout", @@ -2128,66 +2154,45 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "the LB rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, - {}, { "description": "the health monitor UUID", "name": "uuid", "type": "string" }, - { - "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" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the health monitor type", - "name": "type", + "description": "the health monitor http method", + "name": "httpmethod", "type": "string" }, + {}, { "description": "the health monitor interval", "name": "interval", "type": "int" }, - {}, - { - "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 health monitor http method", - "name": "httpmethod", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -2200,7 +2205,7 @@ "description": "comma separated list of node (physical or virtual machines) IDs that need to beremoved from the Kubernetes cluster (CKS)", "length": 255, "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "list" }, @@ -2215,76 +2220,81 @@ ], "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster,addNodesToKubernetesCluster", "response": [ + { + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" + }, + {}, + { + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, { "description": "the name of the Kubernetes cluster", "name": "name", "type": "string" }, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "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": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", + "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "Minimum size of the cluster", + "name": "minsize", + "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", + "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 control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", + "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { "description": "Whether autoscaling is enabled for the cluster", @@ -2292,114 +2302,119 @@ "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "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 Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, + { + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" + }, { "description": "Name of CNI Configuration associated with the cluster", "name": "cniconfigname", "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 etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "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 control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "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 account associated with the Kubernetes cluster", - "name": "account", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "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", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { "description": "Public IP Address ID of the cluster", @@ -2407,55 +2422,55 @@ "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", - "type": "string" - }, - { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "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": "zoneid", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, + {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "keypair details", + "name": "keypair", "type": "string" }, - {}, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "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 ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" + }, + { + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" } ], "since": "4.21.0" @@ -2465,13 +2480,6 @@ "isasync": true, "name": "deleteAccountFromProject", "params": [ - { - "description": "name of the account to be removed from the project", - "length": 255, - "name": "account", - "required": true, - "type": "string" - }, { "description": "ID of the project to remove the account from", "length": 255, @@ -2479,26 +2487,33 @@ "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": true, "type": "uuid" + }, + { + "description": "name of the account to be removed from the project", + "length": 255, + "name": "account", + "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": "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", @@ -2512,15 +2527,6 @@ "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": "whether this guest OS is available for end users", "length": 255, @@ -2529,11 +2535,13 @@ "type": "boolean" }, { - "description": "Map of (key/value pairs)", + "description": "the ID of the OS category", "length": 255, - "name": "details", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory,updateOsCategory", "required": false, - "type": "map" + "since": "4.21.0", + "type": "uuid" }, { "description": "UUID of the Guest OS", @@ -2543,6 +2551,13 @@ "required": true, "type": "uuid" }, + { + "description": "Map of (key/value pairs)", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "Unique display name for Guest OS", "length": 255, @@ -2554,8 +2569,24 @@ "related": "listOsTypes,addGuestOs", "response": [ { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "is the guest OS visible for the users", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, + {}, + { + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, { @@ -2568,37 +2599,21 @@ "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", + "description": "the ID of the OS category", + "name": "oscategoryid", "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" @@ -2608,6 +2623,20 @@ "isasync": false, "name": "listGuestVlans", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "limits search results to allocated guest vlan. false by default.", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" + }, { "description": "list guest vlan by vnet", "length": 255, @@ -2616,11 +2645,12 @@ "type": "string" }, { - "description": "list guest vlan by id", + "description": "list guest vlan by physical network", "length": 255, - "name": "id", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "long" + "type": "uuid" }, { "description": "list guest vlan by zone", @@ -2638,11 +2668,11 @@ "type": "integer" }, { - "description": "limits search results to allocated guest vlan. false by default.", + "description": "list guest vlan by id", "length": 255, - "name": "allocatedonly", + "name": "id", "required": false, - "type": "boolean" + "type": "long" }, { "description": "", @@ -2650,97 +2680,67 @@ "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": "", "response": [ - { - "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 project id of the guest VLAN range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the guest VLAN", - "name": "vlan", + "description": "the zone name of the guest VLAN range", + "name": "zonename", "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "description": "the project id of the guest VLAN range", + "name": "projectid", "type": "string" }, { - "description": "the zone name of the guest VLAN range", - "name": "zonename", + "description": "the physical network ID of the guest VLAN range", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", - "type": "string" + "description": "date the guest VLAN was taken", + "name": "taken", + "type": "date" }, { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the guest VLAN", + "name": "vlan", "type": "string" }, { - "description": "the allocation state of the guest VLAN", - "name": "allocationstate", - "type": "string" + "description": "true if the guest VLAN is dedicated to the account", + "name": "isdedicated", + "type": "boolean" }, + {}, { - "description": "the physical network name of the guest VLAN range", - "name": "physicalnetworkname", + "description": "the zone ID of the guest VLAN range", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, + { + "description": "the list of networks who use this guest VLAN", + "name": "network", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -2751,14 +2751,29 @@ "name": "project", "type": "string" }, + { + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" + }, + { + "description": "the allocation state of the guest VLAN", + "name": "allocationstate", + "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", + "description": "the domain name of the guest VLAN range", + "name": "domain", + "type": "string" + }, + { + "description": "the physical network name of the guest VLAN range", + "name": "physicalnetworkname", "type": "string" } ], @@ -2770,11 +2785,11 @@ "name": "updateResourceLimit", "params": [ { - "description": " Maximum resource limit.", + "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": "max", - "required": false, - "type": "long" + "name": "resourcetype", + "required": true, + "type": "integer" }, { "description": "Update resource limits for project", @@ -2793,43 +2808,48 @@ "type": "uuid" }, { - "description": "Tag for the resource type", + "description": "Update resource for a specified account. Must be used with the domainId parameter.", "length": 255, - "name": "tag", + "name": "account", "required": false, - "since": "4.20.0", "type": "string" }, { - "description": "Update resource for a specified account. Must be used with the domainId parameter.", + "description": "Tag for the resource type", "length": 255, - "name": "account", + "name": "tag", "required": false, + "since": "4.20.0", "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. ", + "description": " Maximum resource limit.", "length": 255, - "name": "resourcetype", - "required": true, - "type": "integer" + "name": "max", + "required": false, + "type": "long" } ], "related": "listResourceLimits", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the resource limit", + "name": "account", "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the project name of the resource limit", + "name": "project", + "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": "path of the domain to which the resource limit belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "The tag for the resource limit", + "name": "tag", "type": "string" }, {}, @@ -2840,28 +2860,28 @@ }, {}, { - "description": "the account of the resource limit", - "name": "account", + "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": "path of the domain to which the resource limit belongs", - "name": "domainpath", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, { - "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": "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 project id of the resource limit", - "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" }, { @@ -2870,14 +2890,9 @@ "type": "string" }, { - "description": "The tag for the resource limit", - "name": "tag", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -2898,76 +2913,76 @@ "related": "listGuiThemes,updateGuiTheme,createGuiTheme", "response": [ { - "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", + "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": "Name of the GUI theme.", - "name": "name", + "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", + "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": "ID of the custom GUI theme.", - "name": "id", + "description": "Description of the GUI theme.", + "name": "description", "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", + "description": "Name of the GUI theme.", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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": "When the GUI theme was removed.", - "name": "removed", - "type": "date" + "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", + "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 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": "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 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.21.0.0" @@ -2987,23 +3002,23 @@ } ], "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 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", @@ -3027,32 +3042,32 @@ ], "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": "chain", - "name": "chain", + "description": "crt", + "name": "crt", "type": "string" }, + {}, { "description": "key", "name": "key", "type": "string" }, { - "description": "crt", - "name": "crt", + "description": "chain", + "name": "chain", "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -3072,15 +3087,9 @@ ], "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" }, {}, { @@ -3088,10 +3097,16 @@ "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" } ] }, @@ -3101,18 +3116,12 @@ "name": "startRollingMaintenance", "params": [ { - "description": "the command to execute while hosts are on maintenance", - "length": 255, - "name": "payload", - "required": false, - "type": "string" - }, - { - "description": "if rolling mechanism should continue in case of an error", + "description": "the IDs of the zones to start maintenance on", "length": 255, - "name": "forced", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "list" }, { "description": "the IDs of the pods to start maintenance on", @@ -3123,61 +3132,67 @@ "type": "list" }, { - "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "description": "the IDs of the clusters to start maintenance on", "length": 255, - "name": "timeout", + "name": "clusterids", + "related": "addCluster,listClusters,updateCluster", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the IDs of the zones to start maintenance on", + "description": "if rolling mechanism should continue in case of an error", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", + "name": "forced", "required": false, - "type": "list" + "type": "boolean" }, { "description": "the IDs of the hosts to start maintenance on", "length": 255, "name": "hostids", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": false, "type": "list" }, { - "description": "the IDs of the clusters to start maintenance on", + "description": "the command to execute while hosts are on maintenance", "length": 255, - "name": "clusterids", - "related": "addCluster,listClusters,updateCluster", + "name": "payload", "required": false, - "type": "list" + "type": "string" + }, + { + "description": "optional operation timeout (in seconds) that overrides the global timeout setting", + "length": 255, + "name": "timeout", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "in case of failure, details are displayed", - "name": "details", - "type": "string" + "description": "indicates if the rolling maintenance operation was successful", + "name": "success", + "type": "boolean" }, { "description": "the hosts updated", "name": "hostsupdated", "response": [ { - "description": "the name of the updated host", - "name": "hostname", + "description": "end date of the update on the host", + "name": "enddate", "type": "string" }, { - "description": "end date of the update on the host", - "name": "enddate", + "description": "output of the maintenance script on the host", + "name": "output", "type": "string" }, { - "description": "the ID of the updated host", - "name": "hostid", + "description": "the name of the updated host", + "name": "hostname", "type": "string" }, { @@ -3186,14 +3201,23 @@ "type": "string" }, { - "description": "output of the maintenance script on the host", - "name": "output", + "description": "the ID of the updated host", + "name": "hostid", "type": "string" } ], "type": "list" }, - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "in case of failure, details are displayed", + "name": "details", + "type": "string" + }, { "description": "the hosts skipped", "name": "hostsskipped", @@ -3204,34 +3228,25 @@ "type": "string" }, { - "description": "the name of the skipped host", - "name": "hostname", + "description": "the ID of the skipped host", + "name": "hostid", "type": "string" }, { - "description": "the ID of the skipped host", - "name": "hostid", + "description": "the name of the skipped host", + "name": "hostname", "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ] }, { @@ -3240,11 +3255,11 @@ "name": "listTungstenFabricApplicationPolicySet", "params": [ { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "pagesize", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of zone", @@ -3255,71 +3270,71 @@ "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "", "length": 255, - "name": "applicationpolicysetuuid", + "name": "page", "required": false, - "type": "string" + "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": "createTungstenFabricApplicationPolicySet", "response": [ - { - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - { - "description": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" - }, - {}, { "description": "Tungsten-Fabric application policy uuid", "name": "uuid", "type": "string" }, + { + "description": "Tungsten-Fabric policy 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 zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {} + {}, + { + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" + }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + } ] }, { @@ -3327,13 +3342,6 @@ "isasync": true, "name": "updateNetworkACLList", "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, @@ -3349,14 +3357,6 @@ "required": false, "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 ID of the network ACL", "length": 255, @@ -3364,12 +3364,28 @@ "related": "createNetworkACLList,listNetworkACLLists", "required": true, "type": "uuid" + }, + { + "description": "Description of the network ACL list", + "length": 255, + "name": "description", + "required": false, + "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" } ], "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" }, { @@ -3377,18 +3393,17 @@ "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" - } + }, + {} ], "since": "4.4" }, @@ -3397,27 +3412,11 @@ "isasync": true, "name": "restoreVirtualMachine", "params": [ - { - "description": "used to specify the custom parameters", - "length": 255, - "name": "details", - "required": false, - "since": "4.19.1", - "type": "map" - }, - { - "description": "Optional field to expunge old root volume after restore.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.19.1", - "type": "boolean" - }, { "description": "Virtual Machine ID", "length": 255, "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, @@ -3429,6 +3428,14 @@ "since": "4.19.1", "type": "long" }, + { + "description": "used to specify the custom parameters", + "length": 255, + "name": "details", + "required": false, + "since": "4.19.1", + "type": "map" + }, { "description": "Override root volume's diskoffering.", "length": 255, @@ -3438,202 +3445,140 @@ "since": "4.19.1", "type": "uuid" }, + { + "description": "Optional field to expunge old root volume after restore.", + "length": 255, + "name": "expunge", + "required": false, + "since": "4.19.1", + "type": "boolean" + }, { "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", + "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": false, "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,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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "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": "the list of nics associated with vm", - "name": "nic", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "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": "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", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "type": "string" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the affinity group", + "name": "name", "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": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", "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", + "description": "the ID of the affinity group", "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", + "description": "the description of the affinity group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "State of the Service from LB rule", + "name": "servicestate", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -3642,14 +3587,19 @@ "type": "date" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { "description": "the pool type of the virtual machine", @@ -3657,8 +3607,18 @@ "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { @@ -3667,50 +3627,51 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, + {}, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, - {}, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, + {}, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { "description": "list of variables and values for the variables declared in userdata", @@ -3718,99 +3679,44 @@ "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "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": "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": "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", + "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "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": "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": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", @@ -3818,210 +3724,269 @@ "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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": "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "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", + "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 name of the host for the virtual machine", - "name": "hostname", + "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": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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", - "type": "long" - }, - { - "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 name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "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": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the affinity group", + "description": "the type of the nic", "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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", + "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 ID of the affinity group", - "name": "domainid", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "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": "the traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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 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" } ], "type": "set" }, { - "description": "the state of the virtual machine", - "name": "state", + "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": "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", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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": "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": "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { "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 domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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" }, { @@ -4030,106 +3995,81 @@ "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": "the account associated with the tag", + "name": "account", "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", "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 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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS type id of the vm", + "name": "ostypeid", "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { @@ -4138,53 +4078,48 @@ "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -4192,86 +4127,41 @@ "name": "securitygroup", "response": [ { - "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 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 name of the group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "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": "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 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 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": "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -4280,13 +4170,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { @@ -4300,13 +4190,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -4317,6 +4202,36 @@ ], "type": "set" }, + { + "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 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 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", @@ -4336,24 +4251,126 @@ "type": "set" }, { - "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 description of the security group", - "name": "description", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "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 protocol of the security group rule", + "name": "protocol", + "type": "string" + }, + { + "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 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 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", @@ -4369,224 +4386,152 @@ "type": "string" }, { - "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": "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 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": "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "customer associated with the tag", - "name": "customer", + "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 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" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "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 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 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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the security group", - "name": "name", + "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": "the VM's primary IP address", - "name": "ipaddress", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "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": "Base64 string containing the user data", - "name": "userdata", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "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 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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -4595,16 +4540,86 @@ "type": "long" }, { - "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": "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "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": "CPU arch of the VM", - "name": "arch", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, - {} + { + "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": "OS name of the vm", + "name": "osdisplayname", + "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", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + } ], "since": "3.0.0" }, @@ -4623,10 +4638,16 @@ } ], "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" }, {}, { @@ -4634,16 +4655,10 @@ "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" } ] }, @@ -4661,20 +4676,20 @@ } ], "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": "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" }, {}, @@ -4690,6 +4705,13 @@ "isasync": false, "name": "listUcsBlades", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "ucs manager id", "length": 255, @@ -4711,53 +4733,46 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "associateUcsProfileToBlade", "response": [ { - "description": "ucs blade dn", - "name": "bladedn", + "description": "ucs blade id", + "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": "ucs manager id", + "name": "ucsmanagerid", "type": "string" }, { - "description": "ucs blade id", - "name": "id", + "description": "ucs blade dn", + "name": "bladedn", "type": "string" }, { - "description": "ucs manager id", - "name": "ucsmanagerid", + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { "description": "cloudstack host id this blade associates to", "name": "hostid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -4776,11 +4791,8 @@ ], "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", @@ -4791,8 +4803,11 @@ "name": "volumeiScsiName", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -4833,14 +4848,16 @@ "related": "listOsCategories,addOsCategory", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the OS category", + "name": "name", + "type": "string" }, + {}, + {}, { - "description": "Whether the OS category is featured", - "name": "isfeatured", - "type": "boolean" + "description": "Date when the OS category was created.", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -4852,23 +4869,21 @@ "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": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, - { - "description": "the name of the OS category", - "name": "name", - "type": "string" - }, - {} + "description": "Whether the OS category is featured", + "name": "isfeatured", + "type": "boolean" + } ], "since": "4.21.0" }, @@ -4877,13 +4892,6 @@ "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, @@ -4892,13 +4900,6 @@ "required": false, "type": "uuid" }, - { - "description": "list of tags to be added to the host", - "length": 255, - "name": "hosttags", - "required": false, - "type": "list" - }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, @@ -4916,163 +4917,173 @@ "type": "string" }, { - "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" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", + "description": "the new uri for the secondary storage: nfs://host/path", "length": 255, - "name": "istagarule", + "name": "url", + "required": false, + "type": "string" + }, + { + "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this host, externaldetails field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupexternaldetails", "required": false, + "since": "4.22.0", "type": "boolean" }, + { + "description": "list of tags to be added to the host", + "length": 255, + "name": "hosttags", + "required": false, + "type": "list" + }, + { + "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": "allocationstate", + "required": false, + "type": "string" + }, { "description": "the ID of the host to update", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,updateHost", "required": true, "type": "uuid" }, { - "description": "Add an annotation to this host", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "annotation", + "name": "istagarule", "required": false, - "since": "4.11", - "type": "string" + "type": "boolean" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "response": [ { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "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", + "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 cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - {}, - { - "description": "the ID of the host", - "name": "id", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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": "events available for the host", "name": "events", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "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 is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "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": "the host type", - "name": "type", - "type": "type" + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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", - "type": "long" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "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", + "description": "the host version", + "name": "version", + "type": "string" + }, + { + "description": "Total GPUs on the Host", + "name": "gputotal", "type": "long" }, { - "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", + "type": "boolean" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { @@ -5089,18 +5100,13 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -5109,18 +5115,23 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" } ], @@ -5134,89 +5145,90 @@ ], "type": "list" }, + {}, { - "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": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently used", + "name": "memoryused", "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "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", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the ID of the host", + "name": "id", "type": "string" }, { @@ -5225,23 +5237,23 @@ "type": "long" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { @@ -5250,33 +5262,39 @@ "type": "integer" }, { - "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 amount of the host's CPU currently allocated", - "name": "cpuallocated", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "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", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -5285,54 +5303,65 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "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": "the cluster name of the host", "name": "clustername", "type": "string" }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" + }, + {}, { "description": "the amount of the host's CPU currently allocated in MHz", "name": "cpuallocatedvalue", "type": "long" }, { - "description": "the host version", - "name": "version", + "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 ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "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 management server name of the host", - "name": "managementservername", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "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": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { "description": "Used GPUs on the Host", @@ -5340,56 +5369,50 @@ "type": "long" }, { - "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 Zone name of the host", - "name": "zonename", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "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": "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 host type", + "name": "type", + "type": "type" }, { - "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 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": "the management server name of the host", + "name": "managementservername", + "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 instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", "type": "boolean" - }, - {} + } ] }, { @@ -5398,11 +5421,12 @@ "name": "createEgressFirewallRule", "params": [ { - "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "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, + "since": "4.4", + "type": "boolean" }, { "description": "the cidr list to forward traffic from. Multiple entries must be separated by a single comma character (,).", @@ -5412,11 +5436,11 @@ "type": "list" }, { - "description": "error code for this icmp message", + "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmpcode", + "name": "destcidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "the ending port of firewall rule", @@ -5425,14 +5449,6 @@ "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": "type of the icmp message being sent", "length": 255, @@ -5440,6 +5456,13 @@ "required": false, "type": "integer" }, + { + "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", + "length": 255, + "name": "protocol", + "required": true, + "type": "string" + }, { "description": "type of firewallrule: system/user", "length": 255, @@ -5454,13 +5477,6 @@ "required": false, "type": "integer" }, - { - "description": "the cidr list to forward traffic to. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "destcidrlist", - "required": false, - "type": "list" - }, { "description": "the network id of the port forwarding rule", "length": 255, @@ -5468,57 +5484,59 @@ "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": true, "type": "uuid" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", + "required": false, + "type": "integer" } ], "related": "createFirewallRule,listEgressFirewallRules,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "description": "the network id of the firewall rule", - "name": "networkid", + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "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 public ip address id for the firewall rule", - "name": "ipaddressid", + "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", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", + "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 domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5532,8 +5550,18 @@ "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", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -5542,8 +5570,8 @@ "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" }, { @@ -5551,11 +5579,6 @@ "name": "key", "type": "string" }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - }, { "description": "customer associated with the tag", "name": "customer", @@ -5564,19 +5587,15 @@ ], "type": "list" }, + {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "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" }, { @@ -5585,25 +5604,30 @@ "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 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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "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 protocol of the firewall rule", + "name": "protocol", + "type": "string" + }, { "description": "is rule for display to the regular user", "name": "fordisplay", @@ -5611,11 +5635,10 @@ }, {}, { - "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" - }, - {} + } ] }, { @@ -5624,25 +5647,34 @@ "name": "listSecurityGroups", "params": [ { - "description": "", + "description": "list the security group by the id provided", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "description": "lists security groups by virtual machine id", "length": 255, - "name": "keyword", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists security groups by name", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "securitygroupname", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -5653,18 +5685,18 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "lists security groups by name", "length": 255, - "name": "tags", + "name": "securitygroupname", "required": false, - "type": "map" + "type": "string" }, { "description": "list only resources belonging to the domain specified", @@ -5675,134 +5707,43 @@ "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 the security group by the id provided", - "length": 255, - "name": "id", - "related": "createSecurityGroup,listSecurityGroups,updateSecurityGroup", - "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": "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": "lists security groups by virtual machine id", + "description": "List resources by tags (key/value pairs)", "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", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" } ], "related": "createSecurityGroup,updateSecurityGroup", "response": [ - { - "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": "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 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 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" - } - ], - "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": "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 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" }, { @@ -5810,30 +5751,15 @@ "name": "icmptype", "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": "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", @@ -5845,8 +5771,8 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -5855,18 +5781,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -5875,8 +5796,8 @@ "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" }, { @@ -5885,51 +5806,84 @@ "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 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 project name where tag belongs to", + "name": "project", "type": "string" } ], "type": "set" + }, + { + "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" } ], "type": "set" }, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "the project name of the group", "name": "project", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "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 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 name of the security group", - "name": "name", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { @@ -5937,34 +5891,29 @@ "name": "egressrule", "response": [ { - "description": "account owning the security group rule", - "name": "account", + "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": "security group name", + "name": "securitygroupname", "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 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", @@ -5981,9 +5930,9 @@ "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", @@ -5991,8 +5940,13 @@ "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 value", + "name": "value", "type": "string" }, { @@ -6000,6 +5954,16 @@ "name": "projectid", "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", @@ -6009,28 +5973,18 @@ "type": "set" }, { - "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", - "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" }, { - "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" }, { @@ -6039,37 +5993,106 @@ "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" } ], "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 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 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": "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": "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": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" } ] }, @@ -6088,17 +6111,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", - "type": "string" - }, - {}, { "description": "any text associated with the success or failure", "name": "displaytext", @@ -6109,6 +6121,17 @@ "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" @@ -6119,16 +6142,17 @@ "name": "listOauthProvider", "params": [ { - "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": "Name of the provider", + "description": "List by keyword", "length": 255, - "name": "provider", + "name": "keyword", "required": false, "type": "string" }, @@ -6140,12 +6164,11 @@ "type": "integer" }, { - "description": "the ID of the OAuth provider", + "description": "Name of the provider", "length": 255, - "name": "id", - "related": "listOauthProvider,verifyOAuthCodeAndGetUser,updateOauthProvider", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -6158,35 +6181,26 @@ "related": "verifyOAuthCodeAndGetUser,updateOauthProvider", "response": [ {}, - { - "description": "ID of the provider", - "name": "id", - "type": "string" - }, - { - "description": "Name of the provider", - "name": "name", - "type": "string" - }, { "description": "Secret key registered in the OAuth provider", "name": "secretkey", "type": "string" }, + {}, { - "description": "Name of the provider", - "name": "provider", + "description": "ID of the provider", + "name": "id", "type": "string" }, { - "description": "Client ID registered in the OAuth provider", - "name": "clientid", + "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": "Redirect URI registered in the OAuth provider", @@ -6198,16 +6212,25 @@ "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" + }, + { + "description": "Client ID registered in the OAuth provider", + "name": "clientid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Name of the provider", + "name": "name", + "type": "string" } ], "since": "4.19.0" @@ -6227,28 +6250,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": "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" - } + {} ] }, { @@ -6282,19 +6305,13 @@ "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", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, - {}, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { @@ -6303,147 +6320,83 @@ "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", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, + {}, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "ID of the storage fs data volume", + "name": "volumeid", "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 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", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, - { - "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": "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", + "name": "vmstate", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "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 shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -6457,23 +6410,23 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -6482,18 +6435,53 @@ "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, + { + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the shared filesystem provider", + "name": "provider", + "type": "string" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", @@ -6503,34 +6491,24 @@ "name": "nsxlogicalswitchport", "type": "string" }, - { - "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": "Id of the vm to which the nic belongs", "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -6540,12 +6518,7 @@ }, { "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the type of the nic", - "name": "type", + "name": "macaddress", "type": "string" }, { @@ -6554,14 +6527,9 @@ "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { "description": "the ID of the nic", @@ -6569,117 +6537,157 @@ "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the type of the nic", + "name": "type", "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": "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": "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 traffic type of the nic", - "name": "traffictype", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "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 isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" } ], "type": "list" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { "description": "the bytes allocated", "name": "virtualsize", "type": "long" }, - {}, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the shared filesystem", + "name": "id", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + {}, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { @@ -6688,33 +6696,48 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the account associated with the shared filesystem", + "name": "account", "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 account associated with the shared filesystem", - "name": "account", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "size of the shared filesystem in GiB", + "name": "sizegb", + "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", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" } ], @@ -6743,31 +6766,31 @@ ], "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "response": [ + {}, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the project name of the IPv4 subnet", - "name": "project", + "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", + "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", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { "description": "the domain ID of the IPv4 subnet", @@ -6775,9 +6798,9 @@ "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": "the account of the IPv4 subnet", @@ -6785,24 +6808,24 @@ "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the project id of the IPv4 subnet", + "name": "projectid", + "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, {}, { - "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" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" } ], @@ -6825,68 +6848,68 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "response": [ { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" - }, - { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "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 date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", - "type": "string" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -6895,140 +6918,140 @@ "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, - {}, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the system VM type", + "name": "systemvmtype", + "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the ID of the system VM", + "name": "id", "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 ID of the system VM", - "name": "id", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", - "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 ID for the system VM", - "name": "zoneid", - "type": "string" + "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": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the template name for the system VM", + "name": "templatename", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private IP address for the system VM", + "name": "privateip", + "type": "string" }, + {}, { - "description": "the name of the system VM", - "name": "name", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the hostname for the system VM", + "name": "hostname", "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 IP address for the system VM", - "name": "privateip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", - "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", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" } ] @@ -7038,14 +7061,6 @@ "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, @@ -7060,6 +7075,14 @@ "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, @@ -7070,10 +7093,12 @@ ], "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", @@ -7084,13 +7109,11 @@ "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" + } ] }, { @@ -7099,28 +7122,27 @@ "name": "listASNumbers", "params": [ { - "description": "the zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "domain id", + "description": "the network id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "AS number", + "description": "account name", "length": 255, - "name": "asnumber", - "related": "listASNumbers", + "name": "account", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -7130,26 +7152,17 @@ "type": "integer" }, { - "description": "the network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the AS Number range ID", + "description": "the zone ID", "length": 255, - "name": "asnrangeid", - "related": "createASNRange,listASNRanges", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "account name", + "description": "List by keyword", "length": 255, - "name": "account", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "keyword", "required": false, "type": "string" }, @@ -7162,99 +7175,98 @@ "type": "uuid" }, { - "description": "", + "description": "to indicate if the AS number is allocated to any network", "length": 255, - "name": "page", + "name": "isallocated", + "required": false, + "type": "boolean" + }, + { + "description": "AS number", + "length": 255, + "name": "asnumber", + "related": "listASNumbers", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "the AS Number range ID", "length": 255, - "name": "keyword", + "name": "asnrangeid", + "related": "createASNRange,listASNRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "to indicate if the AS number is allocated to any network", + "description": "domain id", "length": 255, - "name": "isallocated", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ { - "description": "Allocation state", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the zone name of the AS Number range", - "name": "zonename", + "description": "Zone ID", + "name": "zoneid", "type": "string" }, - { - "description": "Created Date", - "name": "created", - "type": "date" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the account name", - "name": "account", + "description": "AS Number ID", + "name": "asnrangeid", + "type": "string" + }, + { + "description": "VPC ID", + "name": "vpcid", "type": "string" }, + {}, { "description": "the domain name", "name": "domain", "type": "string" }, { - "description": "VPC Name", - "name": "vpcname", + "description": "Account ID", + "name": "accountid", "type": "string" }, { - "description": "Zone ID", - "name": "zoneid", - "type": "string" + "description": "AS Number", + "name": "asnumber", + "type": "long" }, { - "description": "AS Number ID", - "name": "asnrangeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" + "description": "Allocated Date", + "name": "allocated", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network Name", + "name": "associatednetworkname", "type": "string" }, { - "description": "AS Number", - "name": "asnumber", - "type": "long" - }, - {}, - { - "description": "Network Name", - "name": "associatednetworkname", + "description": "Domain ID", + "name": "domainid", "type": "string" }, { - "description": "Network ID", - "name": "associatednetworkid", + "description": "Allocation state", + "name": "allocationstate", "type": "string" }, { @@ -7263,23 +7275,34 @@ "type": "string" }, { - "description": "Domain ID", - "name": "domainid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "Allocated Date", - "name": "allocated", + "description": "Network ID", + "name": "associatednetworkid", + "type": "string" + }, + {}, + { + "description": "Created Date", + "name": "created", "type": "date" }, { - "description": "Account ID", - "name": "accountid", + "description": "the account name", + "name": "account", "type": "string" }, { - "description": "VPC ID", - "name": "vpcid", + "description": "the zone name of the AS Number range", + "name": "zonename", + "type": "string" + }, + { + "description": "VPC Name", + "name": "vpcname", "type": "string" } ], @@ -7306,7 +7329,11 @@ "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", @@ -7317,11 +7344,7 @@ "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" }, @@ -7330,13 +7353,6 @@ "isasync": false, "name": "listUserData", "params": [ - { - "description": "Userdata name to look for", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "the ID of the Userdata", "length": 255, @@ -7346,55 +7362,54 @@ "type": "uuid" }, { - "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,updateDomain,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "Userdata name to look for", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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": "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": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "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.", @@ -7402,70 +7417,72 @@ "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" } ], "related": "listCniConfiguration", "response": [ { - "description": "the project name of the User Data", - "name": "project", + "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": "path of the domain to which the User Data owner belongs", - "name": "domainpath", + "description": "Name of the User Data", + "name": "name", "type": "string" }, { - "description": "the domain name of the User Data owner", - "name": "domain", + "description": "base64 encoded User Data content", + "name": "userdata", "type": "string" }, {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the owner id of the User Data", - "name": "accountid", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { - "description": "the domain id of the User Data owner", - "name": "domainid", + "description": "the project name of the User Data", + "name": "project", "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 the User Data", - "name": "params", + "description": "the domain name of the User Data owner", + "name": "domain", "type": "string" }, { - "description": "ID of the User Data", - "name": "id", + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Name of the User Data", - "name": "name", + "description": "ID of the User Data", + "name": "id", "type": "string" }, { - "description": "the owner of the User Data", - "name": "account", + "description": "the owner id of the User Data", + "name": "accountid", "type": "string" }, { @@ -7474,8 +7491,14 @@ "type": "string" }, { - "description": "base64 encoded User Data content", - "name": "userdata", + "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" } ], @@ -7487,12 +7510,12 @@ "name": "updateLoadBalancer", "params": [ { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the load balancer", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "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", @@ -7503,35 +7526,39 @@ "type": "string" }, { - "description": "the ID of the load balancer", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "createLoadBalancer,listLoadBalancers", "response": [ { - "description": "Load Balancer source ip network id", - "name": "sourceipaddressnetworkid", + "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" }, - {}, { - "description": "the name of the Load Balancer", - "name": "name", + "description": "the project id of the Load Balancer", + "name": "projectid", "type": "string" }, { - "description": "the account of the Load Balancer", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, { @@ -7540,14 +7567,13 @@ "type": "string" }, { - "description": "the domain of the Load Balancer", - "name": "domain", + "description": "the domain ID of the Load Balancer", + "name": "domainid", "type": "string" }, - {}, { - "description": "Load Balancer network id", - "name": "networkid", + "description": "the name of the Load Balancer", + "name": "name", "type": "string" }, { @@ -7559,6 +7585,11 @@ "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ + { + "description": "the ip address of the instance", + "name": "ipaddress", + "type": "string" + }, { "description": "the name of the instance", "name": "name", @@ -7573,42 +7604,18 @@ "description": "the state of the instance", "name": "state", "type": "string" - }, - { - "description": "the ip address of the instance", - "name": "ipaddress", - "type": "string" } ], "type": "list" }, - { - "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": "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 list of rules associated with the Load Balancer", "name": "loadbalancerrule", "response": [ { - "description": "instance port of the load balancer rule", - "name": "instanceport", + "description": "source port of the load balancer rule", + "name": "sourceport", "type": "integer" }, { @@ -7617,21 +7624,32 @@ "type": "string" }, { - "description": "source port of the load balancer rule", - "name": "sourceport", + "description": "instance port of the load balancer rule", + "name": "instanceport", "type": "integer" } ], "type": "list" }, + {}, { - "description": "Load Balancer source ip", - "name": "sourceipaddress", + "description": "the Load Balancer ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the Load Balancer", + "name": "account", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { @@ -7639,18 +7657,18 @@ "name": "tags", "response": [ { - "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" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -7659,18 +7677,18 @@ "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": "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" }, { @@ -7679,18 +7697,18 @@ "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": "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" } ], @@ -7702,8 +7720,13 @@ "type": "boolean" }, { - "description": "the Load Balancer ID", - "name": "id", + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" } ], @@ -7715,18 +7738,18 @@ "name": "scaleSystemVm", "params": [ { - "description": "The ID of the system vm", + "description": "the service offering ID to apply to the system vm", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "the service offering ID to apply to the system vm", + "description": "The ID of the system vm", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm,scaleSystemVm", "required": true, "type": "uuid" }, @@ -7741,195 +7764,190 @@ "related": "listSystemVms,migrateSystemVm,startSystemVm,stopSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the second DNS for the system VM", - "name": "dns2", - "type": "string" - }, - { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, - {}, { "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 private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the name of the system VM", + "name": "name", "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 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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the agent state of the system VM", + "name": "agentstate", + "type": "string" }, { - "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 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 last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "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 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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "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 host ID for the system VM", + "name": "hostid", + "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the Pod name for the system VM", + "name": "podname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { @@ -7938,14 +7956,19 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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 ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" + }, + { + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" } ] }, @@ -7954,13 +7977,6 @@ "isasync": false, "name": "verifyOAuthCodeAndGetUser", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "Name of the provider", "length": 255, @@ -7968,24 +7984,31 @@ "required": true, "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" }, { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", + "description": "", "length": 255, - "name": "secretcode", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "keyword", + "name": "secretcode", "required": false, "type": "string" } @@ -7993,56 +8016,56 @@ "related": "updateOauthProvider", "response": [ { - "description": "Description of the provider registered", - "name": "description", + "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": "ID of the provider", "name": "id", "type": "string" }, + {}, { - "description": "Name of the provider", - "name": "provider", + "description": "Secret key registered in the OAuth provider", + "name": "secretkey", "type": "string" }, { - "description": "Redirect URI registered in the OAuth provider", - "name": "redirecturi", + "description": "Client ID registered in the OAuth provider", + "name": "clientid", "type": "string" }, + {}, { - "description": "Name of the provider", - "name": "name", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" + "description": "Name of the provider", + "name": "name", + "type": "string" } ], "since": "4.19.0" @@ -8052,14 +8075,6 @@ "isasync": false, "name": "listClusterDrsPlan", "params": [ - { - "description": "ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,listClusters,updateCluster", - "required": false, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -8088,16 +8103,24 @@ "related": "listClusterDrsPlan,generateClusterDrsPlan,executeClusterDrsPlan", "required": false, "type": "uuid" + }, + { + "description": "ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,listClusters,updateCluster", + "required": false, + "type": "uuid" } ], "related": "generateClusterDrsPlan,executeClusterDrsPlan", "response": [ + {}, { - "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", @@ -8108,33 +8131,33 @@ "name": "id", "type": "string" }, - { - "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", + "description": "Id of the cluster", + "name": "clusterid", "type": "string" }, - {}, - {}, { - "description": "Id of the cluster", - "name": "clusterid", + "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", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {}, + {} ], "since": "4.19.0" }, @@ -8144,92 +8167,91 @@ "name": "listClusters", "params": [ { - "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": "CPU arch of the clusters", + "description": "lists clusters by Pod ID", "length": 255, - "name": "arch", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.20.1", - "type": "string" + "type": "uuid" }, { - "description": "lists clusters by allocation state", + "description": "", "length": 255, - "name": "allocationstate", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists clusters by the cluster ID", + "description": "lists clusters by the cluster name", "length": 255, - "name": "id", - "related": "addCluster,listClusters,updateCluster", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "CPU arch of the clusters", "length": 255, - "name": "page", + "name": "arch", "required": false, - "type": "integer" + "since": "4.20.1", + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "whether this cluster is managed by cloudstack", "length": 255, - "name": "name", + "name": "managedstate", "required": false, "type": "string" }, { - "description": "", + "description": "lists clusters by cluster type", "length": 255, - "name": "pagesize", + "name": "clustertype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "keyword", + "name": "showcapacities", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists clusters by hypervisor type", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists clusters by cluster type", + "description": "List by keyword", "length": 255, - "name": "clustertype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "lists clusters by Pod ID", + "description": "lists clusters by allocation state", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "allocationstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "showcapacities", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the name of the storage access group", @@ -8240,59 +8262,45 @@ "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "lists clusters by Zone ID", "length": 255, - "name": "managedstate", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" } ], "related": "addCluster,updateCluster", "response": [ { - "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", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the Pod ID of the cluster", + "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", "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": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { @@ -8301,97 +8309,93 @@ "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, + {}, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "the cluster name", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "the cluster name", + "name": "name", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Pod name", + "name": "podname", + "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 capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the capacity name", + "name": "name", + "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { @@ -8400,21 +8404,42 @@ "type": "long" }, { - "description": "the Pod ID", - "name": "podid", - "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" } ], "type": "list" }, + {}, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the cluster ID", + "name": "id", "type": "string" }, { @@ -8423,20 +8448,18 @@ "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, - {}, - {}, { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" } ] @@ -8447,41 +8470,33 @@ "name": "listProjectInvitations", "params": [ { - "description": "list invitations by id", - "length": 255, - "name": "id", - "related": "listProjectInvitations", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "list by project id", + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list invitations by state", "length": 255, - "name": "isrecursive", + "name": "state", "required": false, - "type": "boolean" + "type": "string" }, { - "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.", @@ -8490,6 +8505,14 @@ "required": false, "type": "boolean" }, + { + "description": "list invitation by user ID", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, { "description": "if true, list only active invitations - having Pending state and ones that are not timed out yet", "length": 255, @@ -8498,74 +8521,80 @@ "type": "boolean" }, { - "description": "list invitations by state", + "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": "list resources by account. Must be used with the domainId parameter.", + "description": "list by project id", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "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,updateDomain,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "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 resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, { "description": "the User ID", "name": "userid", "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" }, + {}, { "description": "the id of the invitation", "name": "id", "type": "string" }, { - "description": "the id of the project", - "name": "projectid", + "description": "the invitation state", + "name": "state", "type": "string" }, + {}, { - "description": "the name of the project", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the email the invitation was sent to", - "name": "email", + "description": "path of the Domain the project belongs to", + "name": "domainpath", "type": "string" }, { @@ -8573,11 +8602,10 @@ "name": "account", "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", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -8585,18 +8613,13 @@ "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the invitation state", - "name": "state", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain the project belongs to", - "name": "domainpath", + "description": "the email the invitation was sent to", + "name": "email", "type": "string" } ], @@ -8608,56 +8631,63 @@ "name": "listEgressFirewallRules", "params": [ { - "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": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the network ID for the egress firewall services", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "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.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "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": "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,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "Lists rule with the specified 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": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list only resources belonging to the domain specified", @@ -8667,59 +8697,42 @@ "required": false, "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", + "name": "page", "required": false, "type": "integer" }, { - "description": "the network ID for the egress firewall services", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", "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": "fordisplay", "required": false, + "since": "4.4", "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 tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" } ], "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule,updateFirewallRule", "response": [ { - "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", - "name": "ipaddress", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { @@ -8727,54 +8740,64 @@ "name": "icmpcode", "type": "integer" }, + { + "description": "the ID of the firewall rule", + "name": "id", + "type": "string" + }, {}, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the network id of the firewall rule", + "name": "networkid", "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 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": "the ID of the firewall rule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 protocol of the firewall rule", + "name": "protocol", + "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 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" }, { - "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 project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -8783,28 +8806,28 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -8815,42 +8838,42 @@ ], "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 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 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 public ip address id for the firewall rule", - "name": "ipaddressid", + "description": "the traffic type for the firewall rule", + "name": "traffictype", "type": "string" }, - {}, { - "description": "the network id of the firewall rule", - "name": "networkid", + "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 state of the rule", + "name": "state", "type": "string" - } + }, + {} ] }, { @@ -8859,35 +8882,28 @@ "name": "listClustersMetrics", "params": [ { - "description": "lists clusters by Pod ID", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "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 the cluster ID", + "description": "lists clusters by Pod ID", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "whether this cluster is managed by cloudstack", "length": 255, @@ -8896,136 +8912,246 @@ "type": "string" }, { - "description": "lists clusters by Zone ID", + "description": "the name of the storage access group", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "storageaccessgroup", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "lists clusters by cluster type", + "description": "lists clusters by allocation state", "length": 255, - "name": "clustertype", + "name": "allocationstate", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "CPU arch of the clusters", + "description": "lists clusters by hypervisor type", "length": 255, - "name": "arch", + "name": "hypervisor", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "lists clusters by hypervisor type", + "description": "flag to display the capacity of the clusters", "length": 255, - "name": "hypervisor", + "name": "showcapacities", + "required": false, + "type": "boolean" + }, + { + "description": "lists clusters by the cluster name", + "length": 255, + "name": "name", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "flag to display the capacity of the clusters", + "description": "lists clusters by cluster type", "length": 255, - "name": "showcapacities", + "name": "clustertype", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "lists clusters by the cluster name", + "description": "lists clusters by the cluster ID", "length": 255, - "name": "name", + "name": "id", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the storage access group", + "description": "lists clusters by Zone ID", "length": 255, - "name": "storageaccessgroup", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the cluster name", - "name": "name", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "DRS imbalance for the cluster", + "name": "drsimbalance", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", + "type": "string" }, { "description": "comma-separated list of storage access groups for the host", "name": "storageaccessgroups", "type": "string" }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "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": "string" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", + "type": "string" + }, + { + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", + "type": "string" + }, { "description": "the total cpu allocated in Ghz", "name": "cpuallocated", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the total cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", "type": "boolean" }, { - "description": "the cluster ID", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + {}, + { + "description": "the Zone name of the cluster", + "name": "zonename", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, + {}, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", + "type": "string" + }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", "type": "boolean" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "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", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the Zone ID of the cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", + "type": "string" + }, + { + "description": "the cluster name", + "name": "name", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "the total cpu used in Ghz", + "name": "cpuused", "type": "string" }, + { + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" + }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -9034,23 +9160,23 @@ "type": "short" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -9064,72 +9190,61 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone name", + "name": "zonename", "type": "string" } ], "type": "list" }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, { "description": "memory allocated notification threshold exceeded", "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the Zone name of the cluster", - "name": "zonename", - "type": "string" - }, - {}, - { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "DRS imbalance for the cluster", - "name": "drsimbalance", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the Pod name of the cluster", + "name": "podname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", - "type": "string" - }, - { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { @@ -9138,115 +9253,23 @@ "type": "map" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "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 allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" - }, - { - "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": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "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" - }, - { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", - "type": "string" - }, { "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", + "description": "running / total hosts in the cluster", + "name": "hosts", "type": "string" } ], @@ -9257,20 +9280,6 @@ "isasync": false, "name": "createBackupSchedule", "params": [ - { - "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" - }, - { - "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, - "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, @@ -9298,26 +9307,40 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "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, + "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, + "type": "string" } ], "related": "updateBackupSchedule,listBackups", "response": [ { - "description": "backup date", - "name": "created", - "type": "date" + "description": "description for the backup", + "name": "description", + "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" }, { - "description": "name of the backup", - "name": "name", + "description": "account id", + "name": "accountid", "type": "string" }, { @@ -9326,38 +9349,38 @@ "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" }, { - "description": "backup offering name", - "name": "backupofferingname", - "type": "string" + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" }, { - "description": "account name", - "name": "account", - "type": "string" + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" }, { - "description": "backup offering id", - "name": "backupofferingid", - "type": "string" + "description": "backup status", + "name": "status", + "type": "status" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", - "type": "long" + "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": "backed up volumes", + "name": "volumes", + "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { @@ -9365,71 +9388,76 @@ "name": "zone", "type": "string" }, - {}, { - "description": "backed up volumes", - "name": "volumes", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "Interval type of the backup", - "name": "intervaltype", + "description": "account name", + "name": "account", "type": "string" }, + {}, { "description": "backup type", "name": "type", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", - "type": "string" + "description": "backup size in bytes", + "name": "size", + "type": "long" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" }, + {}, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "domain name", + "name": "domain", + "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "domain name", - "name": "domain", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, - {}, { - "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": "description for the backup", - "name": "description", + "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "name of the backup", + "name": "name", "type": "string" } ], @@ -9441,11 +9469,12 @@ "name": "listStoragePoolObjects", "params": [ { - "description": "List by keyword", + "description": "id of the storage pool", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { "description": "", @@ -9455,12 +9484,11 @@ "type": "integer" }, { - "description": "id of the storage pool", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { "description": "path to list on storage pool", @@ -9479,30 +9507,14 @@ ], "related": "listImageStoreObjects", "response": [ - { - "description": "Name of the data store object.", - "name": "name", - "type": "string" - }, - { - "description": "Format of template associated with the data store object.", - "name": "format", - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Snapshot ID associated with the data store object.", + "name": "snapshotid", "type": "string" }, { @@ -9511,13 +9523,18 @@ "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Is it a directory.", + "name": "isdirectory", + "type": "boolean" }, { - "description": "Volume ID associated with the data store object.", - "name": "volumeid", + "description": "Template ID associated with the data store object.", + "name": "templateid", + "type": "string" + }, + { + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { @@ -9526,26 +9543,37 @@ "type": "long" }, { - "description": "Template ID associated with the data store object.", - "name": "templateid", + "description": "Template Name associated with the data store object.", + "name": "templatename", "type": "string" }, + {}, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Snapshot Name associated with the data store object.", - "name": "snapshotname", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, + {}, { - "description": "Is it a directory.", - "name": "isdirectory", - "type": "boolean" + "description": "Format of template associated with the data store object.", + "name": "format", + "type": "string" }, - {} + { + "description": "Volume ID associated with the data store object.", + "name": "volumeid", + "type": "string" + }, + { + "description": "Last modified date of the file/directory.", + "name": "lastupdated", + "type": "date" + } ], "since": "4.19.0" }, @@ -9555,24 +9583,23 @@ "name": "listSecondaryStagingStores", "params": [ { - "description": "the staging store provider", + "description": "", "length": 255, - "name": "provider", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the staging store", + "description": "the staging store provider", "length": 255, - "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", + "name": "provider", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the staging store protocol", "length": 255, - "name": "keyword", + "name": "protocol", "required": false, "type": "string" }, @@ -9584,19 +9611,20 @@ "type": "integer" }, { - "description": "the Zone ID for the staging store", + "description": "the ID of the staging store", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,listSecondaryStagingStores,updateCloudToUseObjectStore", "required": false, "type": "uuid" }, { - "description": "the staging store protocol", + "description": "the Zone ID for the staging store", "length": 255, - "name": "protocol", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the name of the staging store", @@ -9606,42 +9634,41 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,createSecondaryStagingStore,updateCloudToUseObjectStore", "response": [ - {}, { - "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 name of the image store", - "name": "name", + "description": "the protocol of the image store", + "name": "protocol", "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", + "description": "the ID of the image store", + "name": "id", "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 url of the image store", + "name": "url", + "type": "string" + }, { "description": "the scope of the image store", "name": "scope", @@ -9652,30 +9679,31 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, { - "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 url of the image store", - "name": "url", + "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 Zone name of the image store", + "name": "zonename", + "type": "string" }, { "description": "the provider name of the image store", @@ -9683,9 +9711,9 @@ "type": "string" }, { - "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" } ], "since": "4.2.0" @@ -9706,40 +9734,15 @@ ], "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,startInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, {}, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -9747,38 +9750,33 @@ "name": "nic", "response": [ { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the type of the nic", + "name": "type", "type": "string" }, { @@ -9787,18 +9785,23 @@ "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": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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" }, { @@ -9807,38 +9810,33 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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": "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 netmask of the nic", - "name": "netmask", - "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 ID of the corresponding network", - "name": "networkid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -9847,48 +9845,48 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "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": "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 traffic type of the nic", - "name": "traffictype", + "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -9897,107 +9895,106 @@ "type": "integer" }, { - "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", "type": "string" } ], "type": "set" }, { - "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, - {}, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { @@ -10006,93 +10003,151 @@ "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + {}, + { + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "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": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "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": "result of the health check if available", + "name": "success", + "type": "boolean" + } + ], + "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 account associated with the router", - "name": "account", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the router", - "name": "name", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "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 project id of the ipaddress", - "name": "projectid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", "type": "string" }, { @@ -10101,81 +10156,59 @@ "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the domain associated with the router", + "name": "domain", "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 corresponding guest network", - "name": "guestnetworkname", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "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": "the date this VPC was created", - "name": "lastupdated", - "type": "date" - }, - { - "description": "result of the health check", - "name": "success", - "type": "boolean" - } - ], - "type": "list" + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the template ID for the router", + "name": "templateid", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "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": "the public netmask for the router", - "name": "publicnetmask", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "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 network domain for the router", + "name": "networkdomain", + "type": "string" } ] }, @@ -10185,10 +10218,10 @@ "name": "resetConfiguration", "params": [ { - "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "description": "the ID of the Domain to reset the parameter value for corresponding domain", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, "type": "uuid" }, @@ -10207,6 +10240,14 @@ "required": true, "type": "string" }, + { + "description": "the ID of the Storage pool to reset the parameter value for corresponding storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" + }, { "description": "the ID of the Image Store to reset the parameter value for corresponding image store", "length": 255, @@ -10216,10 +10257,10 @@ "type": "uuid" }, { - "description": "the ID of the Domain to reset the parameter value for corresponding domain", + "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -10230,61 +10271,48 @@ "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" - }, - { - "description": "the ID of the Cluster to reset the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" } ], "related": "listConfigurations,updateConfiguration", "response": [ { - "description": "the type of the configuration value", - "name": "type", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the description of the configuration", - "name": "description", - "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 type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, { - "description": "the value of the configuration", - "name": "id", - "type": "long" - }, - { - "description": "the value of the configuration", - "name": "value", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" }, { - "description": "the group of the configuration", - "name": "group", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { @@ -10297,36 +10325,41 @@ "name": "component", "type": "string" }, - {}, - {}, { "description": "the name of the configuration", "name": "name", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the value of the configuration", + "name": "id", + "type": "long" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, + { + "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", "name": "scope", "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the description of the configuration", + "name": "description", "type": "string" }, + {}, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the group of the configuration", + "name": "group", "type": "string" } ], @@ -10344,14 +10377,6 @@ "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, @@ -10367,6 +10392,14 @@ "required": true, "type": "string" }, + { + "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 duration in which the conditions have to be true before action is taken", "length": 255, @@ -10378,9 +10411,9 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "response": [ { - "description": "the list of IDs of the conditions that are being evaluated on every interval", - "name": "conditions", - "type": "list" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, { "description": "the cool down period for which the policy should not be evaluated after the action has been taken", @@ -10388,35 +10421,34 @@ "type": "integer" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, - {}, - { - "description": "the duration for which the conditions have to be true before action is taken", - "name": "duration", - "type": "integer" - }, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the project id autoscale policy", + "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 autoscale policy", "name": "project", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { @@ -10425,23 +10457,24 @@ "type": "string" }, { - "description": "name of the autoscale policy", - "name": "name", + "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 list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, + {}, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { @@ -10460,24 +10493,24 @@ "description": "the host ID of ssp server", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -10498,21 +10531,15 @@ "related": "", "response": [ { - "description": "the last time a usage job successfully completed", - "name": "lastsuccessfuljob", - "type": "date" - }, - { - "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", + "description": "the last time a usage job successfully completed", + "name": "lastsuccessfuljob", "type": "date" }, - {}, { "description": "the name of the active usage server", "name": "hostname", @@ -10524,15 +10551,21 @@ "type": "integer" }, {}, + {}, + { + "description": "the last time this Usage Server checked for jobs", + "name": "lastheartbeat", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the state of the usage server", - "name": "state", - "type": "state" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" } ], "since": "4.17.0" @@ -10554,26 +10587,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", + "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": "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.11" }, @@ -10583,13 +10616,18 @@ "name": "cleanVMReservations", "params": [], "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", @@ -10599,95 +10637,160 @@ "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": "Updates Routing firewall rule with specified ID", - "isasync": true, - "name": "updateRoutingFirewallRule", + "description": "Lists object storage pools.", + "isasync": false, + "name": "listObjectStoragePools", "params": [ { - "description": "an optional field, whether to the display the Routing firewall rule to the end user or not", + "description": "the ID of the storage pool", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "addObjectStoragePool,listObjectStoragePools,updateObjectStoragePool", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the Routing firewall rule", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "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 object store", "length": 255, - "name": "customid", + "name": "name", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the object store provider", + "length": 255, + "name": "provider", "required": false, - "since": "4.4", "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "addObjectStoragePool,updateObjectStoragePool", "response": [ + {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the allocated size of the object store", + "name": "storageallocated", + "type": "long" + }, + { + "description": "the url of the object store", + "name": "url", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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 total size of the object store", + "name": "storagetotal", + "type": "long" + }, + {}, + { + "description": "the name of the object store", + "name": "name", "type": "string" }, { - "description": "the ID of the port forwarding rule", + "description": "the ID of the object store", "name": "id", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", + "description": "the provider name of the object store", + "name": "providername", "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" + } + ], + "since": "4.19.0" + }, + { + "description": "Updates Routing firewall rule with specified ID", + "isasync": true, + "name": "updateRoutingFirewallRule", + "params": [ + { + "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" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ID of the Routing firewall rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules,updateRoutingFirewallRule", + "required": true, + "type": "uuid" + } + ], + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "privateendport", "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 list of resource tags associated with the rule", @@ -10698,6 +10801,11 @@ "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", @@ -10708,34 +10816,29 @@ "name": "project", "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", + "description": "tag key name", + "name": "key", "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 account associated with the tag", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -10744,42 +10847,31 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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 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 vm ip address for the port forwarding rule", "name": "vmguestip", "type": "string" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -10788,118 +10880,59 @@ "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Lists object storage pools.", - "isasync": false, - "name": "listObjectStoragePools", - "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the name of the object store", - "length": 255, - "name": "name", - "required": false, + "description": "the ID of the port forwarding rule", + "name": "id", "type": "string" }, { - "description": "the object store provider", - "length": 255, - "name": "provider", - "required": false, + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "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", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the url of the object store", - "name": "url", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "the name of the object store", - "name": "name", + "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 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", + "description": "the state of the rule", + "name": "state", "type": "string" } ], - "since": "4.19.0" + "since": "4.20.0" }, { "description": "create secondary staging store.", @@ -10914,24 +10947,17 @@ "type": "map" }, { - "description": "the URL for the staging store", - "length": 2048, - "name": "url", - "required": true, - "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 scope of the staging store: zone only for now", - "length": 255, - "name": "scope", - "required": false, + "description": "the URL for the staging store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { @@ -10941,19 +10967,25 @@ "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" + }, + { + "description": "the staging store provider name", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -10961,35 +10993,34 @@ "name": "name", "type": "string" }, - { - "description": "the Zone name of the image store", - "name": "zonename", - "type": "string" - }, { "description": "the url of the image store", "name": "url", "type": "string" }, - { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" - }, { "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 ID of the image store", - "name": "id", + "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 Zone name of the image store", + "name": "zonename", "type": "string" }, { @@ -10998,9 +11029,15 @@ "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "description": "the Zone ID of the image store", + "name": "zoneid", + "type": "string" + }, + {}, + { + "description": "the ID of the image store", + "name": "id", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -11008,15 +11045,11 @@ "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" - } + {} ] }, { @@ -11034,27 +11067,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -11063,13 +11096,6 @@ "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": "ID of the custom action", "length": 255, @@ -11085,6 +11111,13 @@ "required": true, "type": "string" }, + { + "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": "Type of the resource", "length": 255, @@ -11096,9 +11129,9 @@ "related": "", "response": [ { - "description": "Result of the action execution", - "name": "result", - "type": "map" + "description": "Name of the action", + "name": "name", + "type": "string" }, { "description": "Whether custom action succeed or not", @@ -11106,16 +11139,10 @@ "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": "Result of the action execution", + "name": "result", + "type": "map" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -11123,11 +11150,17 @@ }, {}, { - "description": "Name of the action", - "name": "name", + "description": "ID of the action", + "name": "id", "type": "string" - } - ], + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} + ], "since": "4.21.0" }, { @@ -11135,14 +11168,6 @@ "isasync": true, "name": "updateLBHealthCheckPolicy", "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", - "type": "string" - }, { "description": "an optional field, whether to the display the policy to the end user or not", "length": 255, @@ -11158,54 +11183,31 @@ "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies,updateLBHealthCheckPolicy", "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, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "createLBHealthCheckPolicy,listLBHealthCheckPolicies", "response": [ - { - "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": "Time to wait when receiving a response from the health check", - "name": "responsetime", - "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", @@ -11213,8 +11215,13 @@ "type": "boolean" }, { - "description": "Number of consecutive health check failures before declaring an instance unhealthy.", - "name": "unhealthcheckthresshold", + "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" }, { @@ -11228,29 +11235,55 @@ "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", - "type": "string" - }, - { - "description": "the description of the healthcheck policy", - "name": "description", - "type": "string" - }, - { - "description": "Number of consecutive health check success before declaring an instance healthy", - "name": "healthcheckthresshold", + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", "type": "int" }, { - "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" } ], "type": "list" }, - {} + {}, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "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 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 domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the id of the zone the HealthCheck policy belongs to", + "name": "zoneid", + "type": "string" + } ], "since": "4.4" }, @@ -11259,14 +11292,6 @@ "isasync": true, "name": "removeTungstenFabricPolicyRule", "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" - }, { "description": "the Uuid of Tungsten-Fabric policy rule", "length": 255, @@ -11280,47 +11305,55 @@ "name": "policyuuid", "required": true, "type": "string" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" } ], "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": "Tungsten-Fabric tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "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" }, + {}, { "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": "list Tungsten-Fabric policy network name", "name": "network", "type": "list" }, - { - "description": "Tungsten-Fabric policy name", - "name": "name", - "type": "string" - }, - {}, {} ] }, @@ -11330,11 +11363,12 @@ "name": "createLoadBalancerRule", "params": [ { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "description": "the domain ID associated with the load balancer", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -11344,29 +11378,6 @@ "since": "4.4", "type": "boolean" }, - { - "description": "public IP address ID from where the network traffic will be load balanced from", - "length": 255, - "name": "publicipid", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "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 (,). By default, all CIDRs are allowed.", - "length": 255, - "name": "cidrlist", - "required": false, - "since": "4.18.0.0", - "type": "list" - }, - { - "description": "The protocol for the LB such as tcp, udp or tcp-proxy.", - "length": 255, - "name": "protocol", - "required": false, - "type": "string" - }, { "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, @@ -11382,20 +11393,34 @@ "type": "integer" }, { - "description": "zone where the load balancer is going to be created. This parameter is required when LB service provider is ElasticLoadBalancerVm", + "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, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, "type": "uuid" }, { - "description": "name of the load balancer rule", + "description": "The protocol for the LB such as tcp, udp, tcp-proxy or ssl.", "length": 255, - "name": "name", + "name": "protocol", + "required": false, + "type": "string" + }, + { + "description": "load balancer algorithm (source, roundrobin, leastconn)", + "length": 255, + "name": "algorithm", "required": true, "type": "string" }, + { + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", + "required": false, + "type": "string" + }, { "description": "the account associated with the load balancer. Must be used with the domainId parameter.", "length": 255, @@ -11404,27 +11429,27 @@ "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)", + "description": "name of the load balancer rule", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "the domain ID associated with the load balancer", + "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": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", + "name": "cidrlist", "required": false, - "type": "uuid" + "since": "4.18.0.0", + "type": "list" }, { - "description": "load balancer algorithm (source, roundrobin, leastconn)", + "description": "public IP address ID from where the network traffic will be load balanced from", "length": 255, - "name": "algorithm", - "required": true, - "type": "string" + "name": "publicipid", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { "description": "the private port of the private IP address/virtual machine where the network traffic will be load balanced to", @@ -11432,39 +11457,57 @@ "name": "privateport", "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, + "type": "uuid" } ], "related": "listLoadBalancerRules,updateLoadBalancerRule", "response": [ { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 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 public ip address", + "name": "publicip", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the public port", + "name": "publicport", + "type": "string" + }, + { + "description": "the name of the load balancer", + "name": "name", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + {}, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { @@ -11473,69 +11516,73 @@ "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, - {}, { "description": "the state of the rule", "name": "state", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", - "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 domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the description of the load balancer", + "name": "description", "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", + "name": "publicipid", + "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { @@ -11543,43 +11590,43 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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": "the project id the tag belongs to", + "name": "projectid", "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": "id of the resource", - "name": "resourceid", + "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" }, { @@ -11588,33 +11635,19 @@ "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": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, - { - "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 guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - } + {} ] }, { @@ -11634,9 +11667,14 @@ "related": "quotaConfigureEmail", "response": [ { - "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 configured account's min balance.", + "name": "minbalance", + "type": "double" }, { "description": "Whether the template is enabled.", @@ -11644,25 +11682,20 @@ "type": "boolean" }, { - "description": "The template's name.", - "name": "templatename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The configured account's id.", + "name": "account", "type": "string" }, { - "description": "The configured account's min balance.", - "name": "minbalance", - "type": "double" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {}, {}, { - "description": "The configured account's id.", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -11684,41 +11717,41 @@ ], "related": "listVsphereStoragePolicies", "response": [ + { + "description": "the name of the Storage Policy", + "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 Zone", - "name": "zoneid", + "description": "the identifier of the Storage Policy in vSphere DataCenter", + "name": "policyid", "type": "string" }, { - "description": "the description of the Storage Policy", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "description": "the description of the Storage Policy", + "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 Storage Policy", - "name": "name", + "description": "the ID of the Storage Policy", + "name": "id", "type": "string" }, - {}, { - "description": "the identifier of the Storage Policy in vSphere DataCenter", - "name": "policyid", + "description": "the ID of the Zone", + "name": "zoneid", "type": "string" } ] @@ -11732,33 +11765,33 @@ "description": "ID of the backup repository to be deleted", "length": 255, "name": "id", - "related": "addBackupRepository,listBackupRepositories", + "related": "addBackupRepository,updateBackupRepository,listBackupRepositories", "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 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" } ], "since": "4.20.0" @@ -11780,9 +11813,9 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,enableOutOfBandManagementForZone,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "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 password", @@ -11790,13 +11823,13 @@ "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, { @@ -11805,8 +11838,8 @@ "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the operation result description", + "name": "description", "type": "string" }, { @@ -11815,9 +11848,9 @@ "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 driver for the host", + "name": "driver", + "type": "string" }, { "description": "the out-of-band management interface powerState of the host", @@ -11825,26 +11858,26 @@ "type": "powerstate" }, { - "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 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", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "description": "the operation result description", - "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" @@ -11854,14 +11887,6 @@ "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, @@ -11871,9 +11896,9 @@ "type": "boolean" }, { - "description": "the description for the backup", + "description": "the name of the backup", "length": 255, - "name": "description", + "name": "name", "required": false, "since": "4.21.0", "type": "string" @@ -11882,12 +11907,31 @@ "description": "ID of the VM", "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" + }, + { + "description": "the description for the backup", + "length": 255, + "name": "description", + "required": false, + "since": "4.21.0", + "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", @@ -11895,23 +11939,271 @@ }, {}, { - "description": "true if operation is executed successfully", - "name": "success", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.14.0" + }, + { + "description": "Lists all IPv6 firewall rules", + "isasync": false, + "name": "listIpv6FirewallRules", + "params": [ + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "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 ipv6 firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" + }, + { + "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": "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": "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 display flag; only ROOT admin is eligible to pass this parameter", + "length": 255, + "name": "fordisplay", + "required": false, "type": "boolean" }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "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" + }, + { + "description": "Lists ipv6 firewall rule with the specified ID", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" + }, + { + "description": "list ipv6 firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + } + ], + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ + { + "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": "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 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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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": "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": "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 starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the protocol of the port forwarding rule", + "name": "protocol", + "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 VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + {}, + { + "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" + }, + { + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" } - ], - "since": "4.14.0" + ] }, { "description": "Stops a system VM.", @@ -11936,29 +12228,19 @@ ], "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - }, - { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, { "description": "the agent state of the system VM", "name": "agentstate", "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 the system VM", + "name": "id", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -11966,110 +12248,126 @@ "name": "templatename", "type": "string" }, + { + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" + }, { "description": "public vlan range", "name": "publicvlan", "type": "list" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the control state of the host for the system VM", + "name": "hostcontrolstate", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the first DNS for the system VM", + "name": "dns1", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, + {}, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Pod name for the system VM", + "name": "podname", "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": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the hostname for the system VM", + "name": "hostname", "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 gateway for the system VM", - "name": "gateway", + "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 private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "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" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -12078,69 +12376,63 @@ "type": "date" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", - "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", + "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": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the name of the system VM", + "name": "name", "type": "string" } ] @@ -12154,34 +12446,34 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "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 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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {} ] }, { @@ -12197,13 +12489,6 @@ "required": true, "type": "uuid" }, - { - "description": "the name of the VPC", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, @@ -12228,42 +12513,34 @@ "since": "4.4", "type": "string" }, - { - "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": "sourcenatipaddress", - "required": false, - "since": "4.19", - "type": "string" - }, { "description": "the display text of the VPC", "length": 255, "name": "displaytext", "required": false, "type": "string" - } - ], - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "response": [ + }, { "description": "the name of the VPC", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "description": "the domain name of the owner", - "name": "domain", + "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": "sourcenatipaddress", + "required": false, + "since": "4.19", "type": "string" - }, + } + ], + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "response": [ { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the second IPv6 DNS for the VPC", + "name": "ip6dns2", "type": "string" }, { @@ -12272,46 +12549,15 @@ "type": "string" }, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "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": "if this VPC has redundant router", - "name": "redundantvpcrouter", + "description": "is vpc for display to the regular user", + "name": "fordisplay", "type": "boolean" }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" - }, { "description": "The routes for the VPC to ease adding route in upstream router", "name": "ip4routes", @@ -12319,178 +12565,36 @@ }, {}, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" - }, - { - "description": "the list of resource tags associated with the project", - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "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": "the project id the tag belongs to", - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the owner of the VPC", - "name": "account", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "the second IPv6 DNS for the VPC", - "name": "ip6dns2", - "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 cidr the VPC", - "name": "cidr", + "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 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 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 destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -12499,26 +12603,31 @@ "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "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" } ], "type": "list" }, + { + "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 value", + "name": "value", + "type": "string" }, { "description": "the capability name", @@ -12526,9 +12635,9 @@ "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" @@ -12537,302 +12646,226 @@ "type": "list" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "the project id of the VPC", + "name": "projectid", "type": "string" }, { - "description": "the project name of the VPC", - "name": "project", + "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": "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", + "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": "Lists all IPv6 firewall rules", - "isasync": false, - "name": "listIpv6FirewallRules", - "params": [ - { - "description": "list ipv6 firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "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 resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "list ipv6 firewall rules by traffic type - ingress or egress", - "length": 255, - "name": "traffictype", - "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 only resources belonging to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,updateDomain,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", - "length": 255, - "name": "fordisplay", - "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": "Lists ipv6 firewall rule with the specified ID", - "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,listIpv6FirewallRules,updateIpv6FirewallRule", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "response": [ - { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" - }, - { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "the list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { - "description": "the list of resource tags associated with the rule", + "description": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "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": "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": "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": "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": "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 project id the tag belongs to", - "name": "projectid", + "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 account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the project name of the VPC", + "name": "project", "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "is firewall for display to the regular user", - "name": "fordisplay", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", + "type": "string" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "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 first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, {}, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the owner of the VPC", + "name": "account", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "if this VPC has redundant router", + "name": "redundantvpcrouter", + "type": "boolean" + }, + { + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", "type": "integer" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" } ] @@ -12853,38 +12886,38 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, { - "description": "ID of VM schedule", + "description": "", "length": 255, - "name": "id", - "related": "createVMSchedule,listVMSchedule,updateVMSchedule", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Action taken by schedule", + "description": "List by keyword", "length": 255, - "name": "action", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "Action taken by schedule", "length": 255, - "name": "page", + "name": "action", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "ID of VM schedule", "length": 255, - "name": "keyword", + "name": "id", + "related": "createVMSchedule,listVMSchedule,updateVMSchedule", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -12897,14 +12930,9 @@ "related": "createVMSchedule,updateVMSchedule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "VM schedule is enabled", @@ -12912,51 +12940,56 @@ "type": "boolean" }, { - "description": "Date when the schedule was created", - "name": "created", - "type": "date" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "the ID of VM schedule", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" }, { "description": "Action", "name": "action", "type": "action" }, + {}, { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, {}, - {}, { "description": "Description of VM schedule", "name": "description", "type": "string" }, { - "description": "the ID of VM schedule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" } ], "since": "4.19.0" @@ -12983,28 +13016,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": "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" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.17.0" }, @@ -13014,11 +13047,12 @@ "name": "addNodesToKubernetesCluster", "params": [ { - "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", + "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": "mountcksisoonvr", - "required": false, - "type": "boolean" + "name": "nodeids", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": true, + "type": "list" }, { "description": "the ID of the Kubernetes cluster", @@ -13030,12 +13064,11 @@ "type": "uuid" }, { - "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)", + "description": "(optional) Vmware only, uses the CKS cluster network VR to mount the CKS ISO", "length": 255, - "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" + "name": "mountcksisoonvr", + "required": false, + "type": "boolean" }, { "description": "(optional) indicates if the node is marked for manual upgrade and excluded from the Kubernetes cluster upgrade operation", @@ -13047,60 +13080,94 @@ ], "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ + { + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the account associated with the Kubernetes cluster", + "name": "account", + "type": "string" + }, { "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": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" + }, + { + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, + { + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" + }, { "description": "Whether autoscaling is enabled for the cluster", "name": "autoscalingenabled", "type": "boolean" }, - {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { @@ -13109,68 +13176,63 @@ "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": "zonename", + "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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 name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", + "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 service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "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", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { @@ -13179,114 +13241,95 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, + {}, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Maximum size of the cluster", - "name": "maxsize", + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "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", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "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", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "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 project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, - {}, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "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 Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, + {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" } ], @@ -13306,18 +13349,19 @@ "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "tags", + "name": "retrieveonlyresourcecount", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "the cluster id the disk volume belongs to", + "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": "clusterid", - "related": "addCluster,updateCluster", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.19.1", "type": "uuid" }, { @@ -13328,27 +13372,28 @@ "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", + "description": "List by keyword", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "keyword", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "string" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "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.", + "description": "list volumes by disk offering", "length": 255, - "name": "listall", + "name": "diskofferingid", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", "required": false, - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -13359,68 +13404,58 @@ "type": "uuid" }, { - "description": "list volumes by disk offering", + "description": "list volumes on specified host", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the type of disk volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "type", "required": false, - "since": "4.3", "type": "string" }, { - "description": "the IDs of the volumes, mutually exclusive with id", + "description": "", "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", + "name": "page", "required": false, - "since": "4.9", - "type": "list" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only volumes that are encrypted", "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", + "name": "isencrypted", "required": false, + "since": "4.19.1", "type": "boolean" }, { - "description": "the pod id the disk volume belongs to", + "description": "the ID of the virtual machine", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "listsystemvms", + "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.18", - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "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": "the ID of the disk volume", @@ -13431,124 +13466,107 @@ "type": "uuid" }, { - "description": "the type of disk volume", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "type", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the virtual machine", + "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": "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", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "list only volumes that are encrypted", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isencrypted", + "name": "tags", "required": false, - "since": "4.19.1", - "type": "boolean" + "type": "map" }, { - "description": "list volumes on specified host", + "description": "the ID of the availability zone", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "name", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list system VMs; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "listsystemvms", "required": false, - "type": "string" + "since": "4.18", + "type": "boolean" }, { - "description": "the ID of the availability zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the name of the disk volume", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", - "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 date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "name of the disk volume", - "name": "name", + "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -13557,173 +13575,138 @@ "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "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", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "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", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "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 the volume is extractable, false otherwise", - "name": "isextractable", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "disk size in GiB", - "name": "sizegb", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "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": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the total disk iops", + "name": "diskiopstotal", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the total disk iops", - "name": "diskiopstotal", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the project id of the vpn", + "name": "projectid", "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": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -13732,88 +13715,88 @@ "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, - {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, + {}, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 list of resource tags associated", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -13822,61 +13805,56 @@ "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 domain associated with the tag", + "name": "domain", "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": "tag value", + "name": "value", "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": "resource type", - "name": "resourcetype", + "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": "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 status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { @@ -13885,8 +13863,43 @@ "type": "boolean" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "disk size in GiB", + "name": "sizegb", + "type": "string" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { @@ -13895,44 +13908,74 @@ "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "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 volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" + }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the status of the volume", + "name": "status", + "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 domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" } ], @@ -13961,22 +14004,22 @@ "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": "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", - "type": "string" - } + {} ], "since": "4.13" }, @@ -13989,7 +14032,7 @@ "description": "Load balancer rule ID", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, @@ -14002,18 +14045,18 @@ "type": "uuid" }, { - "description": "ID of SSL certificate", + "description": "Account ID", "length": 255, - "name": "certid", - "related": "uploadSslCert,listSslCerts", + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "Account ID", + "description": "ID of SSL certificate", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "certid", + "related": "uploadSslCert,listSslCerts", "required": false, "type": "uuid" } @@ -14021,14 +14064,9 @@ "related": "uploadSslCert", "response": [ { - "description": "certificate chain", - "name": "certchain", - "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": "SSL certificate ID", @@ -14036,55 +14074,60 @@ "type": "string" }, { - "description": "the project id of the certificate", - "name": "projectid", + "description": "certificate", + "name": "certificate", "type": "string" }, { - "description": "name", - "name": "name", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, { - "description": "account for the certificate", - "name": "account", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "List of loabalancers this certificate is bound to", + "name": "loadbalancerrulelist", + "type": "list" + }, + { + "description": "name", + "name": "name", "type": "string" }, + {}, { "description": "the project name of the certificate", "name": "project", "type": "string" }, - {}, { - "description": "certificate fingerprint", - "name": "fingerprint", + "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": "certificate chain", + "name": "certchain", + "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, { - "description": "certificate", - "name": "certificate", + "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": "account for the certificate", + "name": "account", "type": "string" } ] @@ -14094,20 +14137,6 @@ "isasync": false, "name": "listPrivateGateways", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "list gateways by state", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, { "description": "list private gateway by id", "length": 255, @@ -14117,38 +14146,37 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list gateways by ip address", "length": 255, - "name": "isrecursive", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { - "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": "list gateways by ip address", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "ipaddress", + "name": "account", "required": false, "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list gateways by state", "length": 255, - "name": "account", + "name": "state", "required": false, "type": "string" }, { - "description": "list gateways by vlan", + "description": "List by keyword", "length": 255, - "name": "vlan", + "name": "keyword", "required": false, "type": "string" }, @@ -14167,12 +14195,18 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list gateways by vlan", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "vlan", "required": false, - "type": "uuid" + "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": "list gateways by vpc", @@ -14183,80 +14217,87 @@ "type": "uuid" }, { - "description": "", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "pagesize", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "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": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "response": [ - {}, { - "description": "Source Nat enable status", - "name": "sourcenatsupported", - "type": "boolean" + "description": "VPC name the private gateway belongs to", + "name": "vpcname", + "type": "string" }, - {}, { "description": "the gateway", "name": "gateway", "type": "string" }, { - "description": "the project id of the private gateway", - "name": "projectid", + "description": "the account associated with the private gateway", + "name": "account", "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": "ACL name set for private gateway", - "name": "aclname", + "description": "the private gateway's netmask", + "name": "netmask", "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 private gateway belongs", + "name": "domainpath", + "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the domain associated with the private gateway", + "name": "domain", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", "type": "string" }, { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { - "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" }, { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "VPC name the private gateway belongs to", - "name": "vpcname", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the private gateway's ip address", + "name": "ipaddress", "type": "string" }, { @@ -14265,58 +14306,60 @@ "type": "string" }, { - "description": "the id of the private gateway", - "name": "id", + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" }, + {}, + {}, { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account associated with the private gateway", - "name": "account", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the id of the private gateway", + "name": "id", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", - "type": "string" + "description": "Source Nat enable status", + "name": "sourcenatsupported", + "type": "boolean" }, { - "description": "State of the gateway, can be Creating, Ready, Deleting", - "name": "state", - "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", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { - "description": "path of the domain to which the private gateway belongs", - "name": "domainpath", + "description": "ACL Id set for private gateway", + "name": "aclid", "type": "string" } ] @@ -14326,13 +14369,6 @@ "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, @@ -14340,168 +14376,216 @@ "related": "listNics", "required": true, "type": "uuid" + }, + { + "description": "Secondary IP Address", + "length": 255, + "name": "ipaddress", + "required": false, + "type": "string" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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 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 type id of the vm", - "name": "ostypeid", + "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, { "description": "the ID of the virtual machine", "name": "id", "type": "string" }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, { "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "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", - "type": "string" + "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", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "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 availability zone for the virtual machine", - "name": "zoneid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { @@ -14510,105 +14594,431 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, - { - "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the name of the security group", - "name": "name", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "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 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" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "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": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "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": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "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": "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 vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "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", + "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": "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "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 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", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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": "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" + } + ], + "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 egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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": "id of the resource", + "name": "resourceid", "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": "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" }, { @@ -14617,145 +15027,133 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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 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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "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", + "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": "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 code for the ICMP message response", - "name": "icmpcode", + "description": "the ending IP of the security group rule ", + "name": "endport", "type": "integer" } ], "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 domain name of the security group", + "name": "domain", + "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", + "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 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": "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", + "description": "the protocol of the security group rule", + "name": "protocol", "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": "tag value", - "name": "value", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "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": "customer associated with the tag", - "name": "customer", - "type": "string" - } - ], - "type": "set" - }, - { - "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 starting IP of the security group rule", "name": "startport", "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -14763,6 +15161,16 @@ "name": "icmptype", "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 list of resource tags associated with the rule", "name": "tags", @@ -14773,28 +15181,28 @@ "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": "resource type", + "name": "resourcetype", "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 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" }, { @@ -14803,123 +15211,98 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "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 name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" - }, - { - "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" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" } ], "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 project name of the group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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 name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "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 date when this virtual machine was created", @@ -14927,97 +15310,50 @@ "type": "date" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "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": "resource type", - "name": "resourcetype", - "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 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 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" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "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 the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { "description": "Instance lease expiry action", @@ -15025,507 +15361,401 @@ "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, {}, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "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": "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 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": "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 availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "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 template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "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 NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", - "type": "string" - }, - { - "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", - "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", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the domain ID of the affinity group", + "name": "domainid", "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 gateway of the nic", - "name": "gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the type of the nic", + "description": "the type of the affinity group", "name": "type", "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 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 project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" } ], "type": "set" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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 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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + } + ] + }, + { + "description": "Starts an existing internal lb vm.", + "isasync": true, + "name": "startInternalLoadBalancerVM", + "params": [ { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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 first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the host ID for the router", + "name": "hostid", "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", + "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the template name for the router", + "name": "templatename", "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" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "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 backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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 project ID of the affinity group", - "name": "projectid", - "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 description of the affinity group", - "name": "description", - "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": "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" - }, - { - "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 domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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 corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, - {}, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "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", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "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" }, { @@ -15533,53 +15763,58 @@ "name": "nic", "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolation uri of the nic", + "name": "isolationuri", "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 type of the nic", - "name": "type", + "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 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 name of the corresponding network", - "name": "networkname", + "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 ID of the nic", + "name": "id", "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 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": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -15588,19 +15823,14 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", @@ -15608,256 +15838,126 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 broadcast uri of the nic", - "name": "broadcasturi", + "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 ip address of the nic", + "name": "ipaddress", + "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "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 IPv6 address of network", - "name": "ip6address", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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" } ], "type": "set" }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" - }, - { - "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" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", - "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 service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, { "description": "the control state of the host for the router", "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the public MAC address for the router", - "name": "publicmacaddress", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { @@ -15865,128 +15965,76 @@ "name": "healthcheckresults", "response": [ { - "description": "the name of the health check on the router", - "name": "checkname", - "type": "string" - }, - { - "description": "result of the health check", + "description": "result of the health check if available", "name": "success", "type": "boolean" }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, { "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": "detailed response generated on running health check", "name": "details", "type": "string" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" } ], "type": "list" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", - "type": "string" - }, - { - "description": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - {}, - { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, - {}, { "description": "the state of the router", "name": "state", "type": "state" }, { - "description": "the hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "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": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the date and time the router 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 name of the router", - "name": "name", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" } ] @@ -15997,19 +16045,12 @@ "name": "updateDiskOffering", "params": [ { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "iopswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "ID of the disk offering", "length": 255, - "name": "displayoffering", - "required": false, - "type": "boolean" + "name": "id", + "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", @@ -16020,25 +16061,16 @@ "type": "string" }, { - "description": "length (in seconds) of the burst", + "description": "state of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", - "required": false, - "since": "4.15", - "type": "long" - }, - { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "name": "state", "required": false, - "since": "4.13", "type": "string" }, { - "description": "bytes write rate of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "bytesreadrate", "required": false, "since": "4.15", "type": "long" @@ -16052,16 +16084,17 @@ "type": "long" }, { - "description": "state of the disk offering", + "description": "the cache mode to use for this disk offering", "length": 255, - "name": "state", + "name": "cachemode", "required": false, + "since": "4.15", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemax", + "name": "iopswriteratemaxlength", "required": false, "since": "4.15", "type": "long" @@ -16074,12 +16107,12 @@ "type": "string" }, { - "description": "the cache mode to use for this disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "cachemode", + "name": "iopswriterate", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { "description": "updates alternate display text of the disk offering with this value", @@ -16089,80 +16122,95 @@ "type": "string" }, { - "description": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "tags", + "name": "byteswriterate", "required": false, "since": "4.15", - "type": "string" + "type": "long" }, { - "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, "since": "4.15", "type": "long" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "bytesreadratemaxlength", + "name": "byteswriteratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "bytes read rate of the disk offering", + "description": "sort key of the disk offering, integer", "length": 255, - "name": "bytesreadrate", + "name": "sortkey", "required": false, - "since": "4.15", - "type": "long" + "type": "integer" }, { - "description": "burst io requests write rate of the disk offering", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "iopswriteratemax", + "name": "bytesreadratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "sort key of the disk offering, integer", + "description": "an optional field, whether to display the offering to the end user or not.", "length": 255, - "name": "sortkey", + "name": "displayoffering", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "burst bytes write rate of the disk offering", + "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": "comma-separated list of tags for the disk offering, tags should match with existing storage pool tags", "length": 255, - "name": "byteswriteratemax", + "name": "tags", + "required": false, + "since": "4.15", + "type": "string" + }, + { + "description": "length (in seconds) of the burst", + "length": 255, + "name": "bytesreadratemaxlength", "required": false, "since": "4.15", "type": "long" }, { - "description": "ID of the disk offering", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "id", - "related": "createDiskOffering,updateDiskOffering,listDiskOfferings", - "required": true, - "type": "uuid" + "name": "iopsreadrate", + "required": false, + "since": "4.15", + "type": "long" }, { - "description": "burst requests read rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "iopsreadratemax", + "name": "iopswriteratemax", "required": false, "since": "4.15", "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriterate", + "name": "byteswriteratemaxlength", "required": false, "since": "4.15", "type": "long" @@ -16171,14 +16219,14 @@ "related": "createDiskOffering,listDiskOfferings", "response": [ { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "state of the disk offering", + "name": "state", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", @@ -16186,115 +16234,125 @@ "type": "integer" }, { - "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "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": "whether to display the offering to the end user or not.", - "name": "displayoffering", + "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 size of the disk offering in GB", - "name": "disksize", - "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": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", + "type": "long" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, {}, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the date this disk offering was created", + "name": "created", + "type": "date" + }, + { + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, {}, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", - "type": "string" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", "type": "long" }, { "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "name": "diskIopsWriteRateMaxLength", "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": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "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": "an alternate display text of the disk offering.", + "name": "displaytext", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -16303,34 +16361,19 @@ "type": "string" }, { - "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 disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the date this disk 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": "io requests read rate of the disk offering", @@ -16338,14 +16381,19 @@ "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" + }, + { + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { "description": "bytes read rate of the disk offering", @@ -16353,23 +16401,23 @@ "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", + "type": "boolean" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", "type": "boolean" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the size of the disk offering in GB", + "name": "disksize", "type": "long" } ] @@ -16379,13 +16427,6 @@ "isasync": false, "name": "removeVirtualMachinesFromKubernetesCluster", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -16398,7 +16439,7 @@ "description": "the IDs of the VMs to remove from the cluster", "length": 255, "name": "virtualmachineids", - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "list" }, @@ -16415,35 +16456,42 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "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", - "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 id of the Kubernetes cluster", + "name": "id", + "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" } ], @@ -16454,13 +16502,6 @@ "isasync": true, "name": "deleteTungstenFabricLogicalRouter", "params": [ - { - "description": "the uuid of Tungsten-Fabric logical router", - "length": 255, - "name": "logicalrouteruuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -16468,30 +16509,37 @@ "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": true, + "type": "string" } ], "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": "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -16527,14 +16575,13 @@ "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "response": [ { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", + "type": "string" }, - {}, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the project id", + "name": "projectid", "type": "string" }, { @@ -16543,59 +16590,64 @@ "type": "long" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the project name", + "name": "project", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, + {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "State of vpn connection", - "name": "state", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the connection ID", + "name": "id", "type": "string" }, - {}, { - "description": "the project name", - "name": "project", + "description": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { @@ -16604,68 +16656,64 @@ "type": "boolean" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the owner", + "name": "account", "type": "string" }, { "description": "State of vpn connection", - "name": "passive", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "name": "state", + "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, + {}, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "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 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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "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", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the domain name of the owner", + "name": "domain", "type": "string" } ] @@ -16676,57 +16724,49 @@ "name": "listKubernetesClusters", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the Kubernetes cluster", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", "required": false, "type": "uuid" }, { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "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": "clustertype", + "name": "listall", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { - "description": "List by keyword", + "description": "state of the Kubernetes cluster", "length": 255, - "name": "keyword", + "name": "state", "required": false, "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 ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,listKubernetesClusters,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -16734,13 +16774,6 @@ "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 only resources belonging to the domain specified", "length": 255, @@ -16750,11 +16783,11 @@ "type": "uuid" }, { - "description": "state of the Kubernetes cluster", + "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": "name of the Kubernetes cluster (a substring match is made against the parameter value, data for all matching Kubernetes clusters will be returned)", @@ -16762,39 +16795,59 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "type of the cluster: CloudManaged, ExternalManaged", + "length": 255, + "name": "clustertype", + "required": false, + "since": "4.19.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", "response": [ { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "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": "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 list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" }, { "description": "the control nodes count for the Kubernetes cluster", @@ -16802,43 +16855,33 @@ "type": "long" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" - }, - { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "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 Kubernetes cluster", - "name": "serviceofferingname", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "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 Kubernetes cluster exists", + "name": "domain", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" - }, - { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { @@ -16847,23 +16890,23 @@ "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", + "type": "string" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { @@ -16872,45 +16915,48 @@ "type": "integer" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", - "type": "string" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", - "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": "the account associated with the Kubernetes cluster", "name": "account", "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, - {}, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { @@ -16919,54 +16965,56 @@ "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, + {}, + {}, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "Public IP Address of the cluster", + "name": "ipaddress", + "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "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", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the state of the Kubernetes cluster", @@ -16974,23 +17022,18 @@ "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" - }, - { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", - "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 service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -16999,14 +17042,29 @@ "type": "boolean" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", + "type": "string" + }, + { + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" + }, + { + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -17016,27 +17074,20 @@ "name": "createAutoScaleVmGroup", "params": [ { - "description": "the ID of the load balancer rule", - "length": 255, - "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", - "required": true, - "type": "uuid" - }, - { - "description": "the name of the autoscale vmgroup", + "description": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "the ID of the load balancer rule", "length": 255, - "name": "interval", - "required": false, - "type": "integer" + "name": "lbruleid", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" }, { "description": "the autoscale profile that contains information about the vms in the vm group.", @@ -17047,12 +17098,11 @@ "type": "uuid" }, { - "description": "list of scaleup 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": "scaleuppolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "maxmembers", "required": true, - "type": "list" + "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.", @@ -17062,19 +17112,19 @@ "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.", + "description": "the frequency in which the performance counters to be collected", "length": 255, - "name": "maxmembers", - "required": true, + "name": "interval", + "required": false, "type": "integer" }, { - "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": "list of scaledown autoscale policies", @@ -17083,95 +17133,46 @@ "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, "type": "list" + }, + { + "description": "list of scaleup autoscale policies", + "length": 255, + "name": "scaleuppolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": true, + "type": "list" } ], "related": "disableAutoScaleVmGroup,enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the public ip address", - "name": "publicip", - "type": "string" - }, - { - "description": "the public ip address id", - "name": "publicipid", - "type": "string" - }, - { - "description": "the project id of the vm group", - "name": "projectid", - "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 vm group", - "name": "domain", - "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": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", - "type": "string" + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", "type": "list" }, - {}, - { - "description": "the domain ID of the vm group", - "name": "domainid", - "type": "string" - }, - {}, - { - "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 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", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { @@ -17179,39 +17180,19 @@ "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" - }, - { - "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 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 load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { @@ -17220,130 +17201,98 @@ "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "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 port", - "name": "publicport", + "description": "the domain ID of the vm group", + "name": "domainid", "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 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": "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": "the date when this vm group was created", + "name": "created", + "type": "date" + }, + {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "type": "list" }, { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, + {}, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the account of the bgp peer", + "description": "the account owning the vm group", "name": "account", "type": "string" }, - {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "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": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } - ], - "since": "4.20.0" + ] }, { "description": "Deletes a load balancer rule.", @@ -17354,34 +17303,34 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "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": "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" - } + }, + {} ] }, { @@ -17390,17 +17339,17 @@ "name": "addBaremetalPxePingServer", "params": [ { - "description": "Tftp root directory of PXE server", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "tftpdir", + "name": "username", "required": true, "type": "string" }, { - "description": "Username of PING storage server", + "description": "type of pxe device", "length": 255, - "name": "pingcifsusername", - "required": false, + "name": "pxeservertype", + "required": true, "type": "string" }, { @@ -17411,12 +17360,11 @@ "type": "string" }, { - "description": "Pod Id", + "description": "Tftp root directory of PXE server", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "tftpdir", + "required": true, + "type": "string" }, { "description": "the Physical Network ID", @@ -17427,63 +17375,71 @@ "type": "uuid" }, { - "description": "URL of the external pxe device", + "description": "PING storage server ip", "length": 255, - "name": "url", + "name": "pingstorageserverip", "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": "type of pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pxeservertype", + "name": "password", "required": true, "type": "string" }, { - "description": "Password of PING storage server", + "description": "Pod Id", "length": 255, - "name": "pingcifspassword", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach external pxe device", + "description": "URL of the external pxe device", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "Credentials to reach external pxe device", + "description": "Password of PING storage server", "length": 255, - "name": "username", - "required": true, + "name": "pingcifspassword", + "required": false, "type": "string" } ], "related": "", "response": [ + {}, { - "description": "Root directory on PING storage server", - "name": "pingdir", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, + {}, { "description": "name of the provider", "name": "provider", "type": "string" }, { - "description": "PING storage server ip", - "name": "pingstorageserverip", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Root directory on PING storage server", + "name": "pingdir", "type": "string" }, { @@ -17497,15 +17453,82 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "PING storage server ip", + "name": "pingstorageserverip", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "device id of ", "name": "id", "type": "string" + } + ] + }, + { + "description": "Change the BGP peers for a VPC.", + "isasync": true, + "name": "changeBgpPeersForVpc", + "params": [ + { + "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" + }, + { + "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" + } + ], + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "response": [ + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "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": "password of bgp peer", + "name": "password", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + {}, + { + "description": "IPv4 address of bgp peer", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project id of the bgp peer", + "name": "projectid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -17513,12 +17536,47 @@ "type": "string" }, { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", + "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": "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": "the domain name of the bgp peer", + "name": "domain", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ], + "since": "4.20.0" }, { "description": "list portable IP ranges", @@ -17526,16 +17584,17 @@ "name": "listPortableIpRanges", "params": [ { - "description": "List by keyword", + "description": "Id of the portable ip range", "length": 255, - "name": "keyword", + "name": "id", + "related": "createPortableIpRange,listPortableIpRanges", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Id of a Region", "length": 255, - "name": "page", + "name": "regionid", "required": false, "type": "integer" }, @@ -17547,19 +17606,18 @@ "type": "integer" }, { - "description": "Id of the portable ip range", + "description": "", "length": 255, - "name": "id", - "related": "createPortableIpRange,listPortableIpRanges", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "Id of a Region", + "description": "List by keyword", "length": 255, - "name": "regionid", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createPortableIpRange", @@ -17569,45 +17627,55 @@ "name": "startip", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "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 end ip of the portable IP range", + "name": "endip", "type": "string" }, + {}, { "description": "the netmask of the VLAN IP range", "name": "netmask", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "public IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { @@ -17615,40 +17683,30 @@ "name": "accountid", "type": "string" }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, { "description": "the domain ID the portable IP address is associated with", "name": "domainid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, - { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" - }, { "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", "name": "state", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "public IP address", - "name": "ipaddress", - "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": "VPC the ip belongs to", @@ -17659,14 +17717,14 @@ "type": "list" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", - "type": "string" + "description": "Region Id in which portable ip range is provisioned", + "name": "regionid", + "type": "integer" }, { - "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" } ] }, @@ -17679,13 +17737,18 @@ "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,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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "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 UUID of the latest async job acting on this object", "name": "jobid", @@ -17702,11 +17765,6 @@ "name": "virtualmachineid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {} ], "since": "4.4" @@ -17716,14 +17774,6 @@ "isasync": false, "name": "createNetworkPermissions", "params": [ - { - "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", - "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "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.", "length": 255, @@ -17739,6 +17789,14 @@ "required": false, "type": "list" }, + { + "description": "a comma delimited list of projects within owner's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" + }, { "description": "the network ID", "length": 255, @@ -17749,10 +17807,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", + "type": "string" }, {}, { @@ -17761,16 +17820,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": "4.17.0" }, @@ -17789,11 +17847,7 @@ } ], "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", @@ -17810,7 +17864,11 @@ "name": "displaytext", "type": "string" }, - {} + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -17818,6 +17876,13 @@ "isasync": true, "name": "addIpToNic", "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, @@ -17825,57 +17890,50 @@ "related": "listNics", "required": true, "type": "uuid" - }, - { - "description": "Secondary IP Address", - "length": 255, - "name": "ipaddress", - "required": false, - "type": "string" } ], "related": "", "response": [ + { + "description": "the ID of the network", + "name": "networkid", + "type": "string" + }, + {}, { "description": "the list of Secondary ipv4 addr of nic", "name": "secondaryip", "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 ID of the secondary private IP addr", "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 network", - "name": "networkid", + "description": "the ID of the vm", + "name": "virtualmachineid", "type": "string" }, - {}, { "description": "the ID of the nic", "name": "nicid", "type": "string" }, { - "description": "Secondary IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the ID of the vm", - "name": "virtualmachineid", + "description": "Secondary IP address", + "name": "ipaddress", "type": "string" } ] @@ -17886,11 +17944,12 @@ "name": "quotaTariffUpdate", "params": [ { - "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", + "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, - "type": "date" + "since": "4.18.0.0", + "type": "string" }, { "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.", @@ -17923,6 +17982,13 @@ "since": "4.18.0.0", "type": "string" }, + { + "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, + "type": "date" + }, { "description": "Quota tariff's name", "length": 65535, @@ -17937,48 +18003,53 @@ "name": "value", "required": false, "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": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" + }, + { + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" + }, { "description": "tariffValue", "name": "tariffValue", "type": "bigdecimal" }, { - "description": "usageName", - "name": "usageName", - "type": "string" + "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": "name", + "name": "name", "type": "string" }, - {}, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "usageType", + "name": "usageType", + "type": "int" + }, + { + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "the end date of the quota tariff", - "name": "endDate", - "type": "date" + "description": "currency", + "name": "currency", + "type": "string" }, { - "description": "description", - "name": "description", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { @@ -17987,18 +18058,23 @@ "type": "string" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "description", + "name": "description", "type": "string" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", + "description": "usageName", + "name": "usageName", + "type": "string" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", "type": "date" }, { @@ -18006,31 +18082,13 @@ "name": "id", "type": "string" }, - { - "description": "name", - "name": "name", - "type": "string" - }, + {}, { "description": "when the quota tariff was removed", "name": "removed", "type": "date" }, - { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", - "type": "integer" - }, - { - "description": "usageUnit", - "name": "usageUnit", - "type": "string" - }, - { - "description": "usageType", - "name": "usageType", - "type": "int" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -18054,27 +18112,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": "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" } ] }, @@ -18083,14 +18141,6 @@ "isasync": false, "name": "deleteHost", "params": [ - { - "description": "the host ID", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - }, { "description": "Force destroy local storage on this host. All VMs created on this local storage will be destroyed", "length": 255, @@ -18104,30 +18154,38 @@ "name": "forced", "required": false, "type": "boolean" + }, + { + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "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": "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" } ] }, @@ -18153,12 +18211,10 @@ ], "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", @@ -18169,11 +18225,13 @@ "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.16.0.0" }, @@ -18185,29 +18243,39 @@ "related": "", "response": [ { - "description": "true if Kubernetes Service plugin is enabled, false otherwise", - "name": "kubernetesserviceenabled", + "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", + "name": "allowuserviewdestroyedvm", "type": "boolean" }, { - "description": "true if snapshot is supported for KVM host, false otherwise", - "name": "kvmsnapshotenabled", + "description": "true if users can see all accounts within the same domain, false otherwise", + "name": "allowuserviewalldomainaccounts", + "type": "boolean" + }, + { + "description": "true if additional configurations or extraconfig can be passed to Instances", + "name": "additionalconfigenabled", "type": "boolean" }, + { + "description": "The path of the extensions directory", + "name": "extensionspath", + "type": "string" + }, { "description": "time interval (in seconds) to reset api count", "name": "apilimitinterval", "type": "integer" }, { - "description": "true if the user can recover and expunge volumes, false otherwise", - "name": "allowuserexpungerecovervolume", + "description": "true if region wide secondary is enabled, false otherwise", + "name": "regionsecondaryenabled", "type": "boolean" }, { - "description": "true if dynamically scaling for instances is enabled", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "Max allowed number of api requests within the specified interval", + "name": "apilimitmax", + "type": "integer" }, { "description": "true if users are allowed to force stop a vm, false otherwise", @@ -18215,19 +18283,19 @@ "type": "boolean" }, { - "description": "If invitation confirmation is required when add account to project", - "name": "projectinviterequired", + "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", + "name": "kubernetesclusterexperimentalfeaturesenabled", "type": "boolean" }, { - "description": "true if dynamic role-based api checker is enabled, false otherwise", - "name": "dynamicrolesenabled", - "type": "boolean" + "description": "the retention time for Instances disks stats", + "name": "instancesdisksstatsretentiontime", + "type": "integer" }, { - "description": "true if the user is allowed to view destroyed virtualmachines, false otherwise", - "name": "allowuserviewdestroyedvm", - "type": "boolean" + "description": "the min Ram size for the service offering used by the shared filesystem instance", + "name": "sharedfsvmminramsize", + "type": "integer" }, { "description": "the current status of the latest async job acting on this object", @@ -18235,59 +18303,60 @@ "type": "integer" }, { - "description": "true if stats are retained for instance disks otherwise false", - "name": "instancesdisksstatsretentionenabled", + "description": "version of the cloud stack", + "name": "cloudstackversion", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if regular user is allowed to create projects", + "name": "allowusercreateprojects", "type": "boolean" }, { - "description": "true if stats are collected only for user instances, false if system instance stats are also collected", - "name": "instancesstatsuseronly", + "description": "true if stats are retained for instance disks otherwise false", + "name": "instancesdisksstatsretentionenabled", "type": "boolean" }, { - "description": "the min CPU count for the service offering used by the shared filesystem instance", - "name": "sharedfsvmmincpucount", - "type": "integer" + "description": "If invitation confirmation is required when add account to project", + "name": "projectinviterequired", + "type": "boolean" }, { - "description": "the min Ram size for the service offering used by the shared filesystem instance", - "name": "sharedfsvmminramsize", + "description": "the retention time for Instances stats", + "name": "instancesstatsretentiontime", "type": "integer" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "default page size in the UI for various views, value set in the configurations", + "name": "defaultuipagesize", + "type": "long" }, + {}, { "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", + "description": "true if dynamically scaling for instances is enabled", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "minimum size that can be specified when create disk from disk offering with custom size", - "name": "customdiskofferingminsize", - "type": "long" - }, - { - "description": "the retention time for Instances disks stats", - "name": "instancesdisksstatsretentiontime", - "type": "integer" - }, - { - "description": "the retention time for Instances stats", - "name": "instancesstatsretentiontime", - "type": "integer" + "description": "true if dynamic role-based api checker is enabled, false otherwise", + "name": "dynamicrolesenabled", + "type": "boolean" }, { - "description": "true if regular user is allowed to create projects", - "name": "allowusercreateprojects", - "type": "boolean" + "description": "Display name for custom hypervisor", + "name": "customhypervisordisplayname", + "type": "string" }, { "description": "maximum size that can be specified when create disk from disk offering with custom size", @@ -18295,62 +18364,56 @@ "type": "long" }, { - "description": "true if the user can recover and expunge virtualmachines, false otherwise", - "name": "allowuserexpungerecovervm", + "description": "true if the user can recover and expunge volumes, false otherwise", + "name": "allowuserexpungerecovervolume", "type": "boolean" }, { - "description": "Max allowed number of api requests within the specified interval", - "name": "apilimitmax", + "description": "the min CPU count for the service offering used by the shared filesystem instance", + "name": "sharedfsvmmincpucount", "type": "integer" }, { - "description": "true if experimental features for Kubernetes cluster such as Docker private registry are enabled, false otherwise", - "name": "kubernetesclusterexperimentalfeaturesenabled", + "description": "true if instance lease feature is enabled", + "name": "instanceleaseenabled", "type": "boolean" }, { - "description": "Display name for custom hypervisor", - "name": "customhypervisordisplayname", - "type": "string" + "description": "true if user and domain admins can set templates to be shared, false otherwise", + "name": "userpublictemplateenabled", + "type": "boolean" }, { - "description": "default page size in the UI for various views, value set in the configurations", - "name": "defaultuipagesize", + "description": "minimum size that can be specified when create disk from disk offering with custom size", + "name": "customdiskofferingminsize", "type": "long" }, { - "description": "The path of the extensions directory", - "name": "extensionspath", - "type": "string" + "description": "true if stats are collected only for user instances, false if system instance stats are also collected", + "name": "instancesstatsuseronly", + "type": "boolean" }, - {}, { - "description": "version of the cloud stack", - "name": "cloudstackversion", - "type": "string" + "description": "true if the user can recover and expunge virtualmachines, false otherwise", + "name": "allowuserexpungerecovervm", + "type": "boolean" }, { - "description": "true if instance lease feature is enabled", - "name": "instanceleaseenabled", + "description": "true if Kubernetes Service plugin is enabled, false otherwise", + "name": "kubernetesserviceenabled", "type": "boolean" }, { - "description": "true if user and domain admins can set templates to be shared, false otherwise", - "name": "userpublictemplateenabled", + "description": "true if snapshot is supported for KVM host, false otherwise", + "name": "kvmsnapshotenabled", "type": "boolean" }, - {}, { - "description": "true if region wide secondary is enabled, false otherwise", - "name": "regionsecondaryenabled", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -18368,28 +18431,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": "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" - } + {} ] }, { @@ -18397,6 +18460,13 @@ "isasync": true, "name": "updateNetworkServiceProvider", "params": [ + { + "description": "Enabled/Disabled/Shutdown the physical network service provider", + "length": 255, + "name": "state", + "required": false, + "type": "string" + }, { "description": "network service provider id", "length": 255, @@ -18405,13 +18475,6 @@ "required": true, "type": "uuid" }, - { - "description": "Enabled/Disabled/Shutdown the physical network service provider", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, { "description": "the list of services to be enabled for this physical network service provider", "length": 255, @@ -18422,52 +18485,52 @@ ], "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "response": [ + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, { "description": "the provider name", "name": "name", "type": "string" }, + {}, { "description": "the physical network this belongs to", "name": "physicalnetworkid", "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": "state of the network provider", + "name": "state", + "type": "string" }, + {}, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "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": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", "type": "boolean" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" } ], "since": "3.0.0" @@ -18496,44 +18559,45 @@ "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": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, + {}, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -18541,13 +18605,18 @@ "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", + "name": "name", + "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -18556,160 +18625,98 @@ "type": "integer" }, { - "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 disk utilization", - "name": "utilization", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the path of the volume", - "name": "path", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "ID of the disk volume", + "name": "id", "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "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" - }, - { - "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { @@ -18718,186 +18725,247 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, + {}, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "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": "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": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, - {}, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", - "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "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": "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 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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" + } + ], + "type": "set" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "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", + "type": "long" }, { - "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": "ID of the disk offering", - "name": "diskofferingid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "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": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { "description": "true if the volume is extractable, false otherwise", @@ -18905,18 +18973,13 @@ "type": "boolean" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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" } ], @@ -18927,6 +18990,13 @@ "isasync": false, "name": "listManagementServersMetrics", "params": [ + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "include system level stats", "length": 255, @@ -18935,6 +19005,21 @@ "required": false, "type": "boolean" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "the id of the management server", + "length": 255, + "name": "id", + "related": "listManagementServers", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -18949,28 +19034,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "the id of the management server", - "length": 255, - "name": "id", - "related": "listManagementServers", - "required": false, - "type": "uuid" - }, { "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, @@ -18983,75 +19046,80 @@ "related": "", "response": [ { - "description": "The number of blocked threads", - "name": "threadsblockedcount", + "description": "The number of terminated threads", + "name": "threadsteminatedcount", "type": "integer" }, { - "description": "The number of waiting threads", - "name": "threadswaitingcount", - "type": "integer" + "description": "Total system memory", + "name": "systemmemorytotal", + "type": "string" }, { - "description": "the number of host agents this Management Server is responsible for", - "name": "agentscount", - "type": "long" + "description": "the total system cpu capacity", + "name": "systemtotalcpucycles", + "type": "double" }, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", - "type": "string" + "description": "the Management Server Peers", + "name": "peers", + "type": "list" }, - {}, { - "description": "Total system memory", - "name": "systemmemorytotal", - "type": "string" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of pending jobs in this Management Server", - "name": "pendingjobscount", - "type": "long" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, + {}, { - "description": "The number of runnable threads", - "name": "threadsrunnablecount", + "description": "The number of blocked threads", + "name": "threadsblockedcount", "type": "integer" }, { - "description": "the system is running against a local database", - "name": "dbislocal", - "type": "boolean" + "description": "Free system memory", + "name": "systemmemoryfree", + "type": "string" }, { - "description": "The number of daemon threads", - "name": "threadsdaemoncount", - "type": "integer" + "description": "the number of client sessions active on this Management Server", + "name": "sessions", + "type": "long" }, { - "description": "The number of terminated threads", - "name": "threadsteminatedcount", + "description": "the amount of memory used by this Management Server", + "name": "heapmemoryused", + "type": "long" + }, + { + "description": "The number of waiting threads", + "name": "threadswaitingcount", "type": "integer" }, { - "description": "the name of the management server", - "name": "name", + "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "Amount of memory used", + "name": "systemmemoryused", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" + "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", @@ -19059,80 +19127,70 @@ "type": "double[]" }, { - "description": "the ID of the management server", - "name": "id", - "type": "string" - }, - { - "description": "the last time the host on which this Management Server runs was booted", - "name": "lastboottime", - "type": "date" + "description": "the agents this Management Server is responsible for", + "name": "agents", + "type": "list" }, { - "description": "Free system memory", - "name": "systemmemoryfree", + "description": "the name of the management server", + "name": "name", "type": "string" }, { - "description": "the log files and their usage on disk", - "name": "loginfo", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "description": "the Management Server Peers", - "name": "peers", - "type": "list" - }, - { - "description": "the number of processors available to the JVM", - "name": "availableprocessors", - "type": "integer" + "description": "the ID of the management server", + "name": "id", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the time these statistics were collected", - "name": "collectiontime", + "description": "the last time this Management Server was stopped", + "name": "lastserverstop", "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the version of the management server", - "name": "version", + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", "type": "string" }, { - "description": "the last time this Management Server was stopped", - "name": "lastserverstop", - "type": "date" + "description": "the system has a usage server running locally", + "name": "usageislocal", + "type": "boolean" }, {}, { - "description": "Amount of memory used", - "name": "systemmemoryused", - "type": "string" + "description": "the amount of memory allocated to this Management Server", + "name": "heapmemorytotal", + "type": "long" }, { - "description": "the number of client sessions active on this Management Server", - "name": "sessions", - "type": "long" + "description": "the number of agents this Management Server is responsible for", + "name": "agentcount", + "type": "integer" }, { - "description": "the IP Address for this Management Server", - "name": "ipaddress", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the current cpu load", + "name": "cpuload", + "type": "string" }, { "description": "the last time this Management Server was started", @@ -19140,64 +19198,69 @@ "type": "date" }, { - "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", - "name": "lastagents", - "type": "list" + "description": "the number of processors available to the JVM", + "name": "availableprocessors", + "type": "integer" }, { - "description": "the agents this Management Server is responsible for", - "name": "agents", - "type": "list" + "description": "the system is running against a local database", + "name": "dbislocal", + "type": "boolean" }, { - "description": "Virtual size of the fully loaded process", - "name": "systemmemoryvirtualsize", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "the system has a usage server running locally", - "name": "usageislocal", - "type": "boolean" + "description": "the log files and their usage on disk", + "name": "loginfo", + "type": "string" }, { - "description": "the name of the OS distribution running on the management server", - "name": "osdistribution", - "type": "string" + "description": "the system load for user, and system processes and the system idle cycles", + "name": "systemcycleusage", + "type": "long[]" }, { - "description": "the amount of memory used by this Management Server", - "name": "heapmemoryused", - "type": "long" + "description": "The number of daemon threads", + "name": "threadsdaemoncount", + "type": "integer" }, { - "description": "the number of agents this Management Server is responsible for", - "name": "agentcount", + "description": "The number of threads", + "name": "threadstotalcount", "type": "integer" }, { - "description": "the total system cpu capacity", - "name": "systemtotalcpucycles", - "type": "double" + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" }, { - "description": "the current cpu load", - "name": "cpuload", + "description": "the java distribution name running the management server process", + "name": "javadistribution", "type": "string" }, { - "description": "the system load for user, and system processes and the system idle cycles", - "name": "systemcycleusage", - "type": "long[]" + "description": "Virtual size of the fully loaded process", + "name": "systemmemoryvirtualsize", + "type": "string" }, { - "description": "the amount of memory allocated to this Management Server", - "name": "heapmemorytotal", - "type": "long" + "description": "The number of runnable threads", + "name": "threadsrunnablecount", + "type": "integer" }, { - "description": "The number of threads", - "name": "threadstotalcount", - "type": "integer" + "description": "the IP Address for this Management Server", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" } ], "since": "4.17.0" @@ -19207,6 +19270,14 @@ "isasync": true, "name": "removeFromLoadBalancerRule", "params": [ + { + "description": "The ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", + "required": true, + "type": "uuid" + }, { "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].ip=10.1.1.75", "length": 255, @@ -19219,39 +19290,31 @@ "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": "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", + "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,createVMFromBackup,createVMFromBackup,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,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": "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": "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" }, {} @@ -19263,31 +19326,30 @@ "name": "listInstanceGroups", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "list instance groups by name", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "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": "", "length": 255, - "name": "pagesize", + "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 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" }, @@ -19307,9 +19369,9 @@ "type": "string" }, { - "description": "list instance groups by name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, @@ -19322,54 +19384,69 @@ "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "isrecursive", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "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": "createInstanceGroup,updateInstanceGroup", "response": [ + { + "description": "the ID of the instance group", + "name": "id", + "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": "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": "the project name of the instance group", + "name": "project", + "type": "string" }, { "description": "the domain name of the instance group", "name": "domain", "type": "string" }, - {}, { - "description": "the project name of the instance group", - "name": "project", - "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 instance group", "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", @@ -19380,26 +19457,12 @@ "name": "projectid", "type": "string" }, - { - "description": "the ID of the instance group", - "name": "id", - "type": "string" - }, { "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" - } + {} ] }, { @@ -19408,59 +19471,60 @@ "name": "createStaticRoute", "params": [ { - "description": "the vpc id for which the static route is created. This is required for nexthop parameter", + "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, - "since": "4.21.0", "type": "uuid" }, { - "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", + "description": "static route cidr", "length": 255, - "name": "nexthop", - "required": false, - "since": "4.21.0", + "name": "cidr", + "required": true, "type": "string" }, { - "description": "the gateway id we are creating static route for. Mutually exclusive with the nexthop parameter", + "description": "the vpc id for which the static route is created. This is required for nexthop parameter", "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "static route cidr", + "description": "the next hop of static route. Mutually exclusive with the gatewayid parameter", "length": 255, - "name": "cidr", - "required": true, + "name": "nexthop", + "required": false, + "since": "4.21.0", "type": "string" } ], "related": "listStaticRoutes", "response": [ { - "description": "static route CIDR", - "name": "cidr", + "description": "the state of the static route", + "name": "state", "type": "string" }, { - "description": "the account associated with the static route", - "name": "account", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" }, { - "description": "the project id of the static route", - "name": "projectid", + "description": "the project name of the static route", + "name": "project", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Next hop of the static route", + "name": "nexthop", + "type": "string" }, { "description": "VPC gateway the route is created for", @@ -19468,28 +19532,34 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the ID of static route", - "name": "id", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, + {}, { - "description": "Next hop of the static route", - "name": "nexthop", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { - "description": "the project name of the static route", - "name": "project", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, { - "description": "the domain path associated with the static route", - "name": "domainpath", + "description": "the ID of the domain associated with the static route", + "name": "domainid", + "type": "string" + }, + { + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { @@ -19497,8 +19567,8 @@ "name": "tags", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -19507,28 +19577,28 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "the account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { @@ -19537,48 +19607,41 @@ "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": "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" } ], "type": "list" }, - {}, - { - "description": "the domain associated with the static route", - "name": "domain", - "type": "string" - }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { - "description": "VPC the static route belongs to", - "name": "vpcid", + "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", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "IP of VPC gateway the route is created for", - "name": "vpcgatewayip", + "description": "the account associated with the static route", + "name": "account", "type": "string" } ] @@ -19598,9 +19661,11 @@ } ], "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" }, { @@ -19608,13 +19673,11 @@ "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", @@ -19628,9 +19691,9 @@ "name": "updateDomain", "params": [ { - "description": "updates domain with this name", + "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", "length": 255, - "name": "name", + "name": "networkdomain", "required": false, "type": "string" }, @@ -19643,9 +19706,9 @@ "type": "uuid" }, { - "description": "Network domain for the domain's networks; empty string will update domainName with NULL value", + "description": "updates domain with this name", "length": 255, - "name": "networkdomain", + "name": "name", "required": false, "type": "string" } @@ -19653,106 +19716,114 @@ "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the name of the domain", - "name": "name", - "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 the domain can own", - "name": "cpulimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, - {}, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", + "type": "string" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "the path of the domain", + "name": "path", "type": "string" }, + { + "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": "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 domain", + "name": "projectavailable", + "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "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", - "type": "string" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { "description": "the UUID of the latest async job acting on this object", @@ -19760,94 +19831,95 @@ "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the path of the domain", - "name": "path", - "type": "string" + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "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 total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total number of networks owned by domain", + "name": "networktotal", "type": "long" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", + "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", - "type": "string" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { "description": "the total number of gpus the domain can own", @@ -19855,54 +19927,44 @@ "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 total number of backups available to this domain", - "name": "backupavailable", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "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", + "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 number of networks the domain can own", + "name": "networklimit", + "type": "string" }, { "description": "the total number of virtual machines deployed by this domain", @@ -19910,83 +19972,84 @@ "type": "long" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "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", + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "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) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the state of the domain", + "name": "state", "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", - "name": "iptotal", - "type": "long" + "description": "the total number of projects the domain can own", + "name": "projectlimit", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" } ] @@ -20008,49 +20071,43 @@ "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", "response": [ { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" - }, - { - "description": "the account owning the vm group", - "name": "account", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "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 id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", - "type": "string" + "description": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "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 public ip address id", - "name": "publicipid", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { @@ -20059,28 +20116,29 @@ "type": "string" }, { - "description": "the project id of the vm group", - "name": "projectid", + "description": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, + {}, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", + "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 account owning the vm group", + "name": "account", + "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 name of the vm group", - "name": "domain", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { @@ -20089,28 +20147,29 @@ "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "the project id of the vm group", + "name": "projectid", "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the autoscale vm group ID", + "name": "id", + "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", + "type": "string" }, + {}, { - "description": "the public port", - "name": "publicport", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -20118,40 +20177,44 @@ "name": "minmembers", "type": "int" }, - {}, { "description": "the name of the autoscale vm group ", "name": "name", "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", + "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { - "description": "the private port", - "name": "privateport", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "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": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" } ] @@ -20162,23 +20225,25 @@ "name": "createSnapshotPolicy", "params": [ { - "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)", + "description": "the ID of the disk volume", "length": 255, - "name": "schedule", + "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": "an optional field, whether to the display the policy to the end user or not", "length": 255, - "name": "maxsnaps", - "required": true, - "type": "integer" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "intervaltype", + "name": "timezone", "required": true, "type": "string" }, @@ -20191,6 +20256,13 @@ "since": "4.21.0", "type": "list" }, + { + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "length": 255, + "name": "intervaltype", + "required": true, + "type": "string" + }, { "description": "This parameter enables the option the snapshot to be copied to supported primary storage", "length": 255, @@ -20200,27 +20272,19 @@ "type": "boolean" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", - "length": 255, - "name": "timezone", - "required": true, - "type": "string" - }, - { - "description": "an optional field, whether to the display the policy to the end user or not", + "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": "fordisplay", + "name": "zoneids", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "since": "4.4", - "type": "boolean" + "type": "list" }, { - "description": "the ID of the disk volume", + "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, - "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": "schedule", "required": true, - "type": "uuid" + "type": "string" }, { "description": "Map of tags (key/value pairs)", @@ -20230,35 +20294,23 @@ "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.", + "description": "maximum number of snapshots to retain", "length": 255, - "name": "zoneids", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "list" + "name": "maxsnaps", + "required": true, + "type": "integer" } ], "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": "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": "the ID of the snapshot policy", - "name": "id", + "description": "the ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -20266,38 +20318,38 @@ "name": "tags", "response": [ { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { - "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": "customer associated with the tag", - "name": "customer", + "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" }, { @@ -20306,37 +20358,38 @@ "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": "the project name where tag belongs to", - "name": "project", + "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" }, - {}, { - "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": "maximum number of snapshots retained", - "name": "maxsnaps", - "type": "int" + "description": "is this policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", + "description": "the ID of the snapshot policy", + "name": "id", "type": "string" }, { @@ -20345,24 +20398,39 @@ "type": "set" }, { - "description": "the ID of the disk volume", - "name": "volumeid", + "description": "the name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "The list of zones in which snapshot backup is scheduled", - "name": "zone", - "type": "set" + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" } ] }, @@ -20381,28 +20449,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": "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.11" }, @@ -20421,112 +20489,30 @@ } ], "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" - }, - {} - ], - "since": "4.19.1" - }, - { - "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, - "type": "string" - }, - { - "description": "ID of the role", - "length": 255, - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "any text associated with the success or failure", + "name": "displaytext", "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" + "since": "4.19.1" }, { "description": "List system virtual machines.", @@ -20534,49 +20520,42 @@ "name": "listSystemVms", "params": [ { - "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "systemvmtype", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "since": "3.0.1", + "type": "uuid" }, { - "description": "the state of the system VM", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "the system VM type. Possible types are \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "keyword", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "the ID of the system VM", + "description": "the Pod ID of the system VM", "length": 255, - "name": "id", - "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the name of the system VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "name", "required": false, - "since": "3.0.1", - "type": "uuid" + "type": "string" }, { "description": "the Zone ID of the system VM", @@ -20595,25 +20574,16 @@ "type": "string" }, { - "description": "the host ID of the system VM", - "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the system VM", + "description": "", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the system VM", + "description": "the state of the system VM", "length": 255, - "name": "name", + "name": "state", "required": false, "type": "string" }, @@ -20623,114 +20593,139 @@ "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the host ID of the system VM", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the system VM", + "length": 255, + "name": "id", + "related": "listSystemVms,migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": false, + "type": "uuid" } ], "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "response": [ { - "description": "the systemvm agent version", - "name": "version", + "description": "the system VM type", + "name": "systemvmtype", "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 first DNS for the system VM", - "name": "dns1", + "description": "the template name for the system VM", + "name": "templatename", "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 last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the public IP address for the system VM", + "name": "publicip", + "type": "string" }, { "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", + "type": "string" + }, { "description": "the Zone name for the system VM", "name": "zonename", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", - "type": "integer" + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", + "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "guest vlan range", + "name": "guestvlan", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "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 link local MAC address for the system vm", + "name": "linklocalmacaddress", + "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { @@ -20738,10 +20733,9 @@ "name": "linklocalip", "type": "string" }, - {}, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { @@ -20750,33 +20744,34 @@ "type": "string" }, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "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 Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "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 netmask for the system VM", + "name": "publicnetmask", + "type": "string" }, + {}, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { @@ -20785,56 +20780,129 @@ "type": "string" }, { - "description": "the ID of the system VM", - "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 public netmask for the system VM", - "name": "publicnetmask", + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" + }, + { + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, + { + "description": "public vlan range", + "name": "publicvlan", + "type": "list" + }, + {}, { "description": "the date and time the system VM was created", "name": "created", "type": "date" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" + }, + { + "description": "the template ID for the system VM", + "name": "templateid", + "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, "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "The rule permission, allow or deny. Default: deny.", + "length": 255, + "name": "permission", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the role", + "length": 255, + "name": "roleid", + "related": "createRole,importRole,listRoles,updateRole", + "required": true, + "type": "uuid" }, { - "description": "the state of the system VM", - "name": "state", + "description": "The description of the role permission", + "length": 255, + "name": "description", + "required": false, + "type": "string" + } + ], + "related": "listRolePermissions", + "response": [ + { + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the permission type of the api name or wildcard rule, allow/deny", + "name": "permission", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", + "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 role permission", + "name": "description", + "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" } - ] + ], + "since": "4.9.0" }, { "description": "Detaches a disk volume from a virtual machine.", @@ -20842,10 +20910,10 @@ "name": "detachVolume", "params": [ { - "description": "the ID of the virtual machine where the volume is detached from", + "description": "the ID of the disk volume", "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,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "id", + "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": false, "type": "uuid" }, @@ -20857,10 +20925,10 @@ "type": "long" }, { - "description": "the ID of the disk volume", + "description": "the ID of the virtual machine where the volume is detached from", "length": 255, - "name": "id", - "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": "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, "type": "uuid" } @@ -20868,93 +20936,103 @@ "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": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "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": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "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", + "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", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" + }, + { + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, { "description": "true if storage snapshot is supported for the volume, false otherwise", "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "the account associated with the disk volume", + "name": "account", "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": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "pod name of the volume", - "name": "podname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { @@ -20963,13 +21041,13 @@ "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "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": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { @@ -20978,160 +21056,98 @@ "type": "boolean" }, { - "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 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": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "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": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "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", + "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "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": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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": "size of the disk volume", - "name": "size", + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", "type": "long" }, { @@ -21140,155 +21156,207 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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 virtual machine", - "name": "vmname", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "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 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": "ID of the disk offering", - "name": "diskofferingid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "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 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "the status of the volume", - "name": "status", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, - {}, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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": "the project name of the vpn", + "name": "project", "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": "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 boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "the path of the volume", + "name": "path", "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": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + {}, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "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": "the ID of the domain associated with the disk volume", - "name": "domainid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "shared or local storage", + "name": "storagetype", "type": "string" } ] @@ -21299,15 +21367,7 @@ "name": "replaceNetworkACLList", "params": [ { - "description": "the ID of the network", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the ID of the network ACL", + "description": "the ID of the network ACL", "length": 255, "name": "aclid", "related": "createNetworkACLList,listNetworkACLLists", @@ -21321,18 +21381,20 @@ "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", "required": false, "type": "uuid" + }, + { + "description": "the ID of the network", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -21342,8 +21404,14 @@ }, {}, { - "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" } ] @@ -21361,77 +21429,77 @@ "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric address group", "length": 255, - "name": "pagesize", + "name": "addressgroupuuid", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the ID of zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric address group", + "description": "", "length": 255, - "name": "addressgroupuuid", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createTungstenFabricAddressGroup", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric address group 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": "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", - "type": "string" - }, - { - "description": "Tungsten-Fabric address group name", - "name": "name", - "type": "string" - }, { "description": "Tungsten-Fabric address group ip prefix", "name": "ipprefix", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "Tungsten-Fabric address group uuid", "name": "uuid", "type": "string" }, - {}, + { + "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" } ] @@ -21453,29 +21521,18 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,issueOutOfBandManagementPowerAction,changeOutOfBandManagementPassword", "response": [ { - "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", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result description", + "name": "description", + "type": "string" }, { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { @@ -21484,23 +21541,38 @@ "type": "string" }, { - "description": "the out-of-band management interface password", - "name": "password", + "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 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 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 username", "name": "username", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the ID of the host", + "name": "hostid", "type": "string" }, {}, @@ -21510,15 +21582,11 @@ "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 operation result", - "name": "status", - "type": "boolean" - } + {} ], "since": "4.9.0" }, @@ -21528,97 +21596,97 @@ "name": "listLdapUsers", "params": [ { - "description": "List by keyword", + "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": "keyword", + "name": "listtype", "required": false, "type": "string" }, { - "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": "", "length": 255, - "name": "userfilter", + "name": "page", "required": false, - "since": "4.13", - "type": "string" + "type": "integer" }, { - "description": "linked domain", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "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": "linked domain", "length": 255, - "name": "listtype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "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": "pagesize", + "name": "userfilter", "required": false, - "type": "integer" + "since": "4.13", + "type": "string" } ], "related": "searchLdap,importLdapUsers", "response": [ + {}, { - "description": "The user's principle", - "name": "principal", + "description": "The user's firstname", + "name": "firstname", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's lastname", + "name": "lastname", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "The user's username", - "name": "username", + "description": "The user's email", + "name": "email", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 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", "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "description": "The user's domain", + "name": "domain", "type": "string" }, - {}, { - "description": "The user's email", - "name": "email", + "description": "The user's username", + "name": "username", "type": "string" } ], @@ -21630,11 +21698,11 @@ "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\")", + "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", "length": 255, - "name": "startdate", - "required": false, - "type": "date" + "name": "action", + "required": true, + "type": "string" }, { "description": "Enable VM schedule. Defaults to true", @@ -21644,12 +21712,18 @@ "type": "boolean" }, { - "description": "ID of the VM for which schedule is to be defined", + "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": "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", + "name": "schedule", "required": true, - "type": "uuid" + "type": "string" + }, + { + "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": "Description of the schedule", @@ -21666,18 +21740,12 @@ "type": "string" }, { - "description": "Action to take on the VM (start/stop/reboot/force_stop/force_reboot).", - "length": 255, - "name": "action", - "required": true, - "type": "string" - }, - { - "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": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "schedule", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, - "type": "string" + "type": "uuid" }, { "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", @@ -21690,24 +21758,24 @@ "related": "updateVMSchedule", "response": [ { - "description": "Timezone of the schedule", - "name": "timezone", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Date when the schedule was created", - "name": "created", + "description": "Date after which the schedule becomes inactive", + "name": "enddate", "type": "date" }, { - "description": "Action", - "name": "action", - "type": "action" + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" }, { - "description": "Description of VM schedule", - "name": "description", - "type": "string" + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" }, { "description": "Cron formatted VM schedule", @@ -21715,13 +21783,18 @@ "type": "string" }, { - "description": "ID of virtual machine", - "name": "virtualmachineid", + "description": "Description of VM schedule", + "name": "description", "type": "string" }, { - "description": "Date from which the schedule is active", - "name": "startdate", + "description": "Action", + "name": "action", + "type": "action" + }, + { + "description": "Date when the schedule was created", + "name": "created", "type": "date" }, { @@ -21730,24 +21803,19 @@ "type": "integer" }, { - "description": "VM schedule is enabled", - "name": "enabled", - "type": "boolean" + "description": "ID of virtual machine", + "name": "virtualmachineid", + "type": "string" }, + {}, { "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", + "description": "Timezone of the schedule", + "name": "timezone", "type": "string" }, {} @@ -21759,14 +21827,6 @@ "isasync": false, "name": "listIpForwardingRules", "params": [ - { - "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -21775,11 +21835,12 @@ "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", @@ -21788,43 +21849,35 @@ "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": "Lists rule with the specified ID.", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,listIpForwardingRules,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, { - "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": "Lists all rules applied to the specified VM.", + "description": "list objects by project; if projectid=-1 lists All VMs", "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,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list the rule belonging to this public IP address", @@ -21837,60 +21890,142 @@ { "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. Resources dedicated to a project are listed only if using the projectid parameter.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": false, + "type": "uuid" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, + {}, { "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 ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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 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 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 ID of the port forwarding rule", + "name": "id", + "type": "string" + }, + { + "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", + "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 state of the rule", + "name": "state", + "type": "string" + }, { "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "name": "publicendport", "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": "the domain associated with the tag", - "name": "domain", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -21899,8 +22034,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -21908,6 +22043,11 @@ "name": "resourcetype", "type": "string" }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the account associated with the tag", "name": "account", @@ -21919,84 +22059,12 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "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 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" } ] }, @@ -22005,28 +22073,6 @@ "isasync": true, "name": "createSnapshot", "params": [ - { - "description": "This parameter enables the option the snapshot to be copied to supported primary storage", - "length": 255, - "name": "usestoragereplication", - "required": false, - "type": "boolean" - }, - { - "description": "The account of the snapshot. The account parameter must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "The ID of the disk volume", - "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, - "type": "uuid" - }, { "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, @@ -22053,11 +22099,20 @@ "type": "string" }, { - "description": "asynchronous backup if true", + "description": "The ID of the disk volume", "length": 255, - "name": "asyncbackup", + "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.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "Currently applicable only for managed storage. Valid location types: 'primary', 'secondary'. Default = 'primary'.", @@ -22066,6 +22121,14 @@ "required": false, "type": "string" }, + { + "description": "policy id of the snapshot, if this is null, then use MANUAL_POLICY.", + "length": 255, + "name": "policyid", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" + }, { "description": "Map of tags (key/value pairs)", "length": 255, @@ -22074,65 +22137,64 @@ "type": "map" }, { - "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": "quiesce vm if true", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "quiescevm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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": "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": "The account of the snapshot. The account parameter must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,revertSnapshot,listSnapshots", "response": [ - {}, { - "description": "name of the availability zone", - "name": "zonename", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "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": "display name of the os on volume", - "name": "osdisplayname", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -22141,77 +22203,52 @@ "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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": "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 os on volume", - "name": "ostypeid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "the status of the template", - "name": "status", + "description": "the type of the snapshot", + "name": "snapshottype", "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 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", "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -22220,8 +22257,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -22230,47 +22267,67 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", + "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 domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "name of the snapshot", - "name": "name", + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", + "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": "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": "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": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -22278,8 +22335,13 @@ "type": "boolean" }, { - "description": "the project name of the snapshot", - "name": "project", + "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", "type": "string" }, { @@ -22287,50 +22349,56 @@ "name": "datastoretype", "type": "string" }, - {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, + {}, { - "description": "name of the disk volume", - "name": "volumename", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "name of the snapshot", + "name": "name", "type": "string" }, + {}, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "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": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" } ] @@ -22341,27 +22409,27 @@ "name": "listStoragePoolsMetrics", "params": [ { - "description": "the Pod ID for the storage pool", + "description": "", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the storage pool", + "description": "list storage pools belonging to the specific cluster", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the storage pool", "length": 255, - "name": "page", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "If true, lists the custom stats of the storage pool", @@ -22372,41 +22440,47 @@ "type": "boolean" }, { - "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 name of the storage pool", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "list storage pools belonging to the specific cluster", + "description": "the IP address for the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "ipaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "host ID of the storage pools", + "description": "the status of the storage pool", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "status", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the storage access group", + "description": "List by keyword", "length": 255, - "name": "storageaccessgroup", + "name": "keyword", "required": false, - "since": "4.21.0", "type": "string" }, { @@ -22418,38 +22492,32 @@ "type": "uuid" }, { - "description": "the storage pool path", + "description": "the scope of the storage pool", "length": 255, - "name": "path", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "the IP address for the storage pool", + "description": "the name of the storage pool", "length": 255, - "name": "ipaddress", + "name": "name", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the scope of the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the storage pool path", "length": 255, - "name": "keyword", + "name": "path", "required": false, "type": "string" } @@ -22457,45 +22525,54 @@ "related": "", "response": [ { - "description": "disk size unallocated in GiB", - "name": "disksizeunallocatedgb", + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "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 Zone name of the storage pool", - "name": "zonename", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "storage allocated notification threshold exceeded", + "name": "storageallocatedthreshold", "type": "boolean" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "disk size allocated in GiB", + "name": "disksizeallocatedgb", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, - {}, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "disk size unallocated in GiB", + "name": "disksizeunallocatedgb", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the storage pool path", + "name": "path", + "type": "string" }, { "description": "disk size in GiB", @@ -22503,33 +22580,28 @@ "type": "string" }, { - "description": "storage allocated disable threshold exceeded", - "name": "storageallocateddisablethreshold", - "type": "boolean" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "storage allocated notification threshold exceeded", - "name": "storageallocatedthreshold", - "type": "boolean" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "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 scope of the storage pool", - "name": "scope", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "disk size allocated in GiB", - "name": "disksizeallocatedgb", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -22537,20 +22609,30 @@ "name": "podname", "type": "string" }, + { + "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 storage pool details", "name": "details", "type": "map" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "disk size used in GiB", + "name": "disksizeusedgb", + "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the Zone name of the storage pool", + "name": "zonename", + "type": "string" }, { "description": "total min IOPS currently in use by volumes", @@ -22558,129 +22640,237 @@ "type": "long" }, { - "description": "storage usage disable threshold exceeded", - "name": "storageusagedisablethreshold", + "description": "storage allocated disable threshold exceeded", + "name": "storageallocateddisablethreshold", "type": "boolean" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool type", + "name": "type", + "type": "string" }, { - "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 IP address of the storage pool", - "name": "ipaddress", + "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", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, - {}, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "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 date and time the storage pool was created", "name": "created", "type": "date" }, + {}, { - "description": "the storage pool type", - "name": "type", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" + }, + { + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, + {}, + { + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "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", - "type": "string" + "description": "storage usage notification threshold exceeded", + "name": "storageusagethreshold", + "type": "boolean" }, { - "description": "disk size used in GiB", - "name": "disksizeusedgb", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" + }, + { + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" + } + ], + "since": "4.9.3" + }, + { + "description": "Update a backup repository", + "isasync": false, + "name": "updateBackupRepository", + "params": [ + { + "description": "shared storage mount options", + "length": 255, + "name": "mountopts", + "required": false, + "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "address of the backup repository", + "length": 255, + "name": "address", + "required": false, "type": "string" }, { - "description": "the ID of the storage pool", + "description": "backups in this repository can be used to create Instances on all Zones", + "length": 255, + "name": "crosszoneinstancecreation", + "required": false, + "type": "boolean" + }, + { + "description": "ID of the backup repository", + "length": 255, + "name": "id", + "related": "addBackupRepository,updateBackupRepository,listBackupRepositories", + "required": true, + "type": "uuid" + }, + { + "description": "name of the backup repository", + "length": 255, + "name": "name", + "required": false, + "type": "string" + } + ], + "related": "addBackupRepository,listBackupRepositories", + "response": [ + { + "description": "the name of the backup repository", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the backup repository", "name": "id", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "the address / url of the backup repository", + "name": "address", "type": "string" }, + {}, { - "description": "storage usage notification threshold exceeded", - "name": "storageusagethreshold", - "type": "boolean" + "description": "the Zone name of the backup repository", + "name": "zonename", + "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone ID of the backup repository", + "name": "zoneid", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", "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": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + { + "description": "backup type", + "name": "type", + "type": "string" } ], - "since": "4.9.3" + "since": "4.22.0" }, { "description": "Create a new keypair and returns the private key", "isasync": false, "name": "createSSHKeyPair", "params": [ + { + "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" + }, { "description": "an optional project for the ssh key", "length": 255, @@ -22702,36 +22892,40 @@ "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": "Private key", - "name": "privatekey", + "description": "Name of the keypair", + "name": "name", + "type": "string" + }, + { + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, + {}, { "description": "Fingerprint of the public key", "name": "fingerprint", "type": "string" }, + {}, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "Private key", + "name": "privatekey", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the owner of the keypair", + "name": "account", + "type": "string" + }, + { + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { @@ -22740,41 +22934,29 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the domain id of the keypair owner", + "name": "domainid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "Name of the keypair", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - }, - {}, - {}, - { - "description": "the domain id of the keypair owner", - "name": "domainid", - "type": "string" } ] }, @@ -22793,26 +22975,26 @@ } ], "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" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, {} ], @@ -22823,13 +23005,6 @@ "isasync": false, "name": "listTungstenFabricServiceGroup", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -22846,32 +23021,29 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric service group", + "description": "", "length": 255, - "name": "servicegroupuuid", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric service group", "length": 255, - "name": "page", + "name": "servicegroupuuid", "required": false, - "type": "integer" + "type": "string" } ], "related": "createTungstenFabricServiceGroup", "response": [ - { - "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", - "type": "integer" - }, { "description": "Tungsten-Fabric service group protocol", "name": "protocol", @@ -22882,6 +23054,11 @@ "name": "name", "type": "string" }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, { "description": "Tungsten-Fabric service group end port", "name": "endport", @@ -22892,7 +23069,11 @@ "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", @@ -22900,13 +23081,14 @@ "type": "string" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" + "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 service group uuid", + "name": "uuid", "type": "string" } ] @@ -22917,46 +23099,31 @@ "name": "authorizeSecurityGroupEgress", "params": [ { - "description": "user to security group mapping", - "length": 255, - "name": "usersecuritygrouplist", - "required": false, - "type": "map" - }, - { - "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", - "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" - }, - { - "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", + "description": "an optional project of the security group", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "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 ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "end port for this egress rule", "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", + "name": "endport", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "type of the icmp message being sent", + "description": "start port for this egress rule", "length": 255, - "name": "icmptype", + "name": "startport", "required": false, "type": "integer" }, @@ -22968,19 +23135,27 @@ "type": "string" }, { - "description": "an optional project of the security group", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, "type": "uuid" }, { - "description": "start port for this egress rule", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "startport", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" + }, + { + "description": "an optional domainId for the security group. 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": "The name of the security group. Mutually exclusive with securityGroupId parameter", @@ -22990,9 +23165,16 @@ "type": "string" }, { - "description": "end port for this egress rule", + "description": "user to security group mapping", "length": 255, - "name": "endport", + "name": "usersecuritygrouplist", + "required": false, + "type": "map" + }, + { + "description": "error code for this icmp message", + "length": 255, + "name": "icmpcode", "required": false, "type": "integer" }, @@ -23007,47 +23189,52 @@ "related": "authorizeSecurityGroupIngress", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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 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": "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 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", "response": [ { - "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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -23056,28 +23243,28 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -23086,19 +23273,13 @@ "type": "string" }, { - "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" } ], "type": "set" }, - {}, { "description": "the CIDR notation for the base IP address of the security group rule", "name": "cidr", @@ -23110,18 +23291,19 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "security group name", - "name": "securitygroupname", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, {} @@ -23134,24 +23316,24 @@ "name": "listStoragePools", "params": [ { - "description": "List by keyword", + "description": "list storage pools belonging to the specific cluster", "length": 255, - "name": "keyword", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the storage pool path", + "description": "the IP address for the storage pool", "length": 255, - "name": "path", + "name": "ipaddress", "required": false, "type": "string" }, { - "description": "the scope of the storage pool", + "description": "the status of the storage pool", "length": 255, - "name": "scope", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "status", "required": false, "type": "string" }, @@ -23164,149 +23346,136 @@ "type": "uuid" }, { - "description": "the Pod ID for the storage pool", + "description": "host ID of the storage pools", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the IP address for the storage pool", + "description": "the storage pool path", "length": 255, - "name": "ipaddress", + "name": "path", "required": false, "type": "string" }, { - "description": "", + "description": "If true, lists the custom stats of the storage pool", "length": 255, - "name": "pagesize", + "name": "storagecustomstats", "required": false, - "type": "integer" + "since": "4.18.1", + "type": "boolean" }, { - "description": "the name of the storage pool", + "description": "the ID of the storage pool", "length": 255, - "name": "name", + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the name of the storage access group", + "description": "", "length": 255, - "name": "storageaccessgroup", + "name": "page", "required": false, - "since": "4.21.0", - "type": "string" + "type": "integer" }, { - "description": "the ID of the storage pool", + "description": "the name of the storage access group", "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "storageaccessgroup", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "string" }, { - "description": "list storage pools belonging to the specific cluster", + "description": "the name of the storage pool", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "If true, lists the custom stats of the storage pool", + "description": "", "length": 255, - "name": "storagecustomstats", + "name": "pagesize", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "integer" }, { - "description": "host ID of the storage pools", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the status of the storage pool", + "description": "the scope of the storage pool", "length": 255, - "name": "status", + "name": "scope", + "related": "cancelStorageMaintenance,createStoragePool,listStoragePools,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "string" }, { - "description": "", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "page", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "response": [ { - "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": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "type": "string" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -23315,61 +23484,64 @@ "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 Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "total IOPS currently in use", + "name": "usediops", "type": "long" }, - {}, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, - {}, { - "description": "the scope of the storage pool", - "name": "scope", - "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": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", + "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": "the name of the storage pool", + "name": "name", + "type": "string" }, { "description": "the nfs mount options for the storage pool", @@ -23377,53 +23549,68 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 tags for the storage pool", - "name": "tags", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "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": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the scope of the storage pool", + "name": "scope", "type": "string" } ] @@ -23434,35 +23621,36 @@ "name": "updateHypervisorCapabilities", "params": [ { - "description": "set true to enable security group for this hypervisor.", + "description": "the maximum number of Data Volumes that can be attached to a VM for this hypervisor.", "length": 255, - "name": "securitygroupenabled", + "name": "maxdatavolumeslimit", "required": false, - "type": "boolean" + "since": "4.16.0", + "type": "integer" }, { - "description": "the maximum number of the hypervisor hosts per cluster ", + "description": "the hypervisor version for which the hypervisor capabilities are to be updated", "length": 255, - "name": "maxhostspercluster", + "name": "hypervisorversion", "required": false, - "since": "4.16.0", - "type": "integer" + "since": "4.19.1", + "type": "string" }, { - "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 maximum number of Data Volumes that can be attached to a VM for this hypervisor.", + "description": "set true to enable VM snapshots for this hypervisor", "length": 255, - "name": "maxdatavolumeslimit", + "name": "vmsnapshotenabled", "required": false, "since": "4.16.0", - "type": "integer" + "type": "boolean" }, { "description": "ID of the hypervisor capability", @@ -23473,58 +23661,52 @@ "type": "uuid" }, { - "description": "set true to enable VM snapshots for this hypervisor", + "description": "the maximum number of the hypervisor hosts per cluster ", "length": 255, - "name": "vmsnapshotenabled", + "name": "maxhostspercluster", "required": false, "since": "4.16.0", - "type": "boolean" + "type": "integer" }, { - "description": "the hypervisor for which the hypervisor capabilities are to be updated", + "description": "set true to enable storage motion support for this hypervisor", "length": 255, - "name": "hypervisor", + "name": "storagemotionenabled", "required": false, - "since": "4.19.1", - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the hypervisor version for which the hypervisor capabilities are to be updated", + "description": "the max number of Guest VMs per host for this hypervisor.", "length": 255, - "name": "hypervisorversion", + "name": "maxguestslimit", "required": false, - "since": "4.19.1", - "type": "string" + "type": "long" }, { - "description": "the max number of Guest VMs per host for this hypervisor.", + "description": "set true to enable security group for this hypervisor.", "length": 255, - "name": "maxguestslimit", + "name": "securitygroupenabled", "required": false, - "type": "long" + "type": "boolean" } ], "related": "listHypervisorCapabilities", "response": [ { - "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 maximum number of Hosts per cluster for this hypervisor", "name": "maxhostspercluster", "type": "integer" }, + {}, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", - "type": "boolean" - }, - { - "description": "true if VM snapshots are enabled for this hypervisor", - "name": "vmsnapshotenabled", + "description": "true if security group is supported", + "name": "securitygroupenabled", "type": "boolean" }, { @@ -23532,37 +23714,42 @@ "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 hypervisor capabilities row", "name": "id", "type": "string" }, - {}, + { + "description": "the maximum number of guest vms recommended for this hypervisor", + "name": "maxguestslimit", + "type": "long" + }, { "description": "the hypervisor version", "name": "hypervisorversion", "type": "string" }, + { + "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 guest vms recommended for this hypervisor", - "name": "maxguestslimit", - "type": "long" - }, - { - "description": "true if security group is supported", - "name": "securitygroupenabled", + "description": "true if storage motion is supported", + "name": "storagemotionenabled", "type": "boolean" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], "since": "3.0.0" }, @@ -23571,21 +23758,21 @@ "isasync": false, "name": "findHostsForMigration", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "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": "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -23596,7 +23783,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -23604,108 +23791,54 @@ "related": "", "response": [ { - "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 resource state of the host", + "name": "resourcestate", + "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", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "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 used", + "name": "memoryused", + "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { "description": "the cpu average load on the host", @@ -23713,143 +23846,183 @@ "type": "double" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "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": "true if migrating a vm to this host requires storage motion, false otherwise", - "name": "requiresStorageMotion", + "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", - "name": "cpuallocated", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the name of the host", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the ID of the host", - "name": "id", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, + {}, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "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": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "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": "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 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 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 displays per user", + "name": "maxheads", + "type": "long" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "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 OS category name of the host", - "name": "oscategoryname", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", + "description": "the date and time the host was last pinged", + "name": "lastpinged", "type": "date" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "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": "true if migrating a vm to this host requires storage motion, false otherwise", + "name": "requiresStorageMotion", + "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", - "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" }, { @@ -23857,104 +24030,100 @@ "name": "version", "type": "string" }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, { "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": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", + "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "comma-separated list of tags for the host", + "name": "hosttags", + "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 name of the host", + "name": "name", + "type": "string" }, { - "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", + "name": "cpuallocated", + "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "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 OS category ID of the host", + "name": "oscategoryid", "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 the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "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": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "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 type", - "name": "type", - "type": "type" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "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": "the Pod ID of the host", - "name": "podid", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { @@ -23963,92 +24132,110 @@ "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "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": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "type": "string" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, + {}, { - "description": "events available for the host", - "name": "events", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, - {}, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the Pod name of the host", + "name": "podname", "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 CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, { "description": "Total GPUs on the Host", "name": "gputotal", "type": "long" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the host type", + "name": "type", + "type": "type" }, { - "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, - {}, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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 management server name of the host", - "name": "managementservername", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "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" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" } ] }, @@ -24068,55 +24255,60 @@ ], "related": "listCiscoNexusVSMs,disableCiscoNexusVSM", "response": [ + { + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", + "type": "string" + }, + {}, { "description": "device state", "name": "vsmdevicestate", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, { "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "device name", "name": "vsmdevicename", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, - { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" - }, { "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" - }, - { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { @@ -24125,20 +24317,15 @@ "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "type": "int" - }, - { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, {}, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" } ] }, @@ -24165,15 +24352,15 @@ "type": "string" }, {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "is domain admin allowed to create offerings with tags", "name": "isallowed", "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -24183,20 +24370,11 @@ "name": "addNicToVirtualMachine", "params": [ { - "description": "Virtual Machine ID", - "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,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": "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" }, { "description": "Mac Address for the new network", @@ -24213,101 +24391,44 @@ "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": "Virtual Machine ID", "length": 255, - "name": "dhcpoptions", - "required": false, - "type": "map" + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "Network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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", - "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "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 name of userdata used for the VM", @@ -24315,14 +24436,14 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "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": "the amount of the vm's CPU currently used", @@ -24330,38 +24451,23 @@ "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", - "type": "integer" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -24369,56 +24475,6 @@ "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": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "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", @@ -24430,245 +24486,100 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "User VM type", + "name": "vmtype", "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": "OS type id of the vm", - "name": "ostypeid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "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", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the name of the affinity group", + "name": "name", "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 account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "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": "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": "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", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "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": "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", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" } ], "type": "set" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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 VM's primary IP address", - "name": "ipaddress", - "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -24677,44 +24588,18 @@ "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, - {}, - { - "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": "the name of the template for the virtual machine", - "name": "templatename", - "type": "string" - }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -24723,379 +24608,110 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "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": "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "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": "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 name of the affinity group", - "name": "project", - "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 account owning the affinity group", - "name": "account", - "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 type of the affinity group", - "name": "type", - "type": "string" - }, - { - "description": "the description of the affinity group", - "name": "description", - "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": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "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", - "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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "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 vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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 VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "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 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 ID of the security group", - "name": "id", - "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" - }, - { - "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 egress rules associated with the security group", + "name": "egressrule", "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 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 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": "id of the resource", + "name": "resourceid", "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": "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": "customer associated with the tag", + "name": "customer", "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": "path of the Domain associated with the tag", + "name": "domainpath", "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": "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" }, { @@ -25107,13 +24723,8 @@ "type": "set" }, { - "description": "security group name", - "name": "securitygroupname", - "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" }, { @@ -25127,133 +24738,158 @@ "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": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "type": "string" } ], "type": "set" }, { - "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": "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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the name of the security group", + "name": "name", + "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": "security group name", - "name": "securitygroupname", - "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 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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "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": "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": "the project id the tag belongs to", + "name": "projectid", "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": "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 code for the ICMP message response", "name": "icmpcode", "type": "integer" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", + "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 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" } ], "type": "set" @@ -25268,16 +24904,6 @@ "name": "virtualmachinecount", "type": "integer" }, - { - "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", @@ -25293,33 +24919,33 @@ "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": "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" }, { - "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 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" }, { @@ -25328,13 +24954,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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -25343,184 +24969,115 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the description of the security group", - "name": "description", + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" - } - ] - }, - { - "description": "Lists all static routes", - "isasync": false, - "name": "listStaticRoutes", - "params": [ - { - "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.", - "length": 255, - "name": "account", - "required": false, + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, + {}, { - "description": "list static routes by vpc id", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "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": "the date when this virtual machine was created", + "name": "created", + "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.", - "length": 255, - "name": "listall", - "required": false, + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "list static routes by gateway id", - "length": 255, - "name": "gatewayid", - "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", - "required": false, - "type": "uuid" - }, - { - "description": "list static route by id", - "length": 255, - "name": "id", - "related": "listStaticRoutes", - "required": false, - "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": "list static routes by state", - "length": 255, - "name": "state", - "required": false, + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "", - "length": 255, - "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, + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" - } - ], - "related": "", - "response": [ + }, { - "description": "the list of resource tags associated with static route", + "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "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": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -25529,1210 +25086,712 @@ "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": "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" } ], - "type": "list" - }, - { - "description": "the account associated with the static route", - "name": "account", - "type": "string" - }, - { - "description": "Next hop of the static route", - "name": "nexthop", - "type": "string" - }, - { - "description": "VPC the static route belongs to", - "name": "vpcid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "static route CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "the project name of the static route", - "name": "project", - "type": "string" - }, - { - "description": "IP of VPC gateway the route is created for", - "name": "vpcgatewayip", - "type": "string" - }, - { - "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" + "type": "set" }, { - "description": "the state of the static route", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, - {}, { - "description": "the ID of static route", - "name": "id", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the domain associated with the static route", - "name": "domainid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the domain associated with the static route", - "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": "the project id of the static route", - "name": "projectid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } - ] - }, - { - "description": "Lists all public ip addresses", - "isasync": false, - "name": "listPublicIpAddresses", - "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "lists the specified IP address", - "length": 255, - "name": "ipaddress", - "required": false, + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if range is dedicated for external network provider", - "length": 255, - "name": "forprovider", - "required": false, - "since": "4.21.0", - "type": "boolean" - }, - { - "description": "lists all public IP addresses by physical network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "lists all public IP addresses by zone ID", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "list only static NAT IP addresses", - "length": 255, - "name": "isstaticnat", - "required": false, + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "lists IP address by ID", - "length": 255, - "name": "id", - "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "list only IPs used for load balancing", - "length": 255, - "name": "forloadbalancing", - "required": false, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "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 only source NAT IP addresses", - "length": 255, - "name": "issourcenat", - "required": false, - "type": "boolean" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "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": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, - "type": "boolean" - }, - { - "description": "limits search results to allocated public IP addresses", - "length": 255, - "name": "allocatedonly", - "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, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "description": "lists all public IP addresses by VLAN ID", - "length": 255, - "name": "vlanid", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the virtual network for the IP address", - "length": 255, - "name": "forvirtualnetwork", - "required": false, - "type": "boolean" - }, - { - "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": "lists all public IP addresses associated to the network specified", - "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "List IPs belonging to the VPC", - "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, - { - "description": "true if range is dedicated for system VMs", - "length": 255, - "name": "forsystemvms", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, - { - "description": "lists all public IP addresses by state", - "length": 255, - "name": "state", - "required": false, + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - } - ], - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "response": [ - { - "description": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "VPC name the ip belongs to", - "name": "vpcname", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", - "type": "boolean" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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 ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the list of resource tags associated with ip address", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" - }, - { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" - }, - { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", - "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 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "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": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" }, { - "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": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, - {}, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", - "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 Network associated with the IP address", - "name": "associatednetworkid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "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": "public IP address id", - "name": "id", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the project name of the address", - "name": "project", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 the host for the virtual machine", + "name": "hostid", + "type": "string" }, { - "description": "the ID of a OpenDaylight Controller", - "length": 255, - "name": "id", - "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", - "required": false, - "type": "uuid" - } - ], - "related": "addOpenDaylightController,deleteOpenDaylightController", - "response": [ + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name assigned to the controller", - "name": "name", + "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the url of the controller api", - "name": "url", - "type": "string" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, - {}, { - "description": "device id of the controller", - "name": "id", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, - {} + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + } ] }, { - "description": "Adds a BigSwitch BCF Controller device", - "isasync": true, - "name": "addBigSwitchBcfDevice", + "description": "Lists all static routes", + "isasync": false, + "name": "listStaticRoutes", "params": [ { - "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "description": "list static route by id", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "id", + "related": "listStaticRoutes", + "required": false, + "type": "uuid" }, { - "description": "NAT support of the BigSwitch BCF Controller.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "nat", - "required": true, - "type": "boolean" + "name": "tags", + "required": false, + "type": "map" }, { - "description": "Username of the BigSwitch BCF Controller.", + "description": "list static routes by vpc id", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "the Physical Network ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": true, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, "type": "uuid" }, { - "description": "Password of the BigSwitch BCF Controller.", + "description": "list static routes by gateway id", "length": 255, - "name": "password", - "required": true, - "type": "string" - } - ], - "related": "listBigSwitchBcfDevices", - "response": [ - { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", - "type": "string" + "name": "gatewayid", + "related": "createPrivateGateway,createPrivateGateway,listPrivateGateways", + "required": false, + "type": "uuid" }, { - "description": "the physical network to which this BigSwitch BCF segment belongs to", - "name": "physicalnetworkid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "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", - "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": "NAT support", - "name": "nat", + "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 controller Ip address", - "name": "hostname", - "type": "string" - }, - { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the controller password", - "name": "password", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, - {}, { - "description": "the controller username", - "name": "username", + "description": "list static routes by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } - ], - "since": "4.6.0" - }, - { - "description": "Changes the default NIC on a VM", - "isasync": true, - "name": "updateDefaultNicForVirtualMachine", - "params": [ { - "description": "NIC 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": "nicid", - "related": "listNics", - "required": true, - "type": "uuid" + "name": "listall", + "required": false, + "type": "boolean" }, { - "description": "Virtual Machine ID", + "description": "", "length": 255, - "name": "virtualmachineid", - "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" + "name": "pagesize", + "required": false, + "type": "integer" } ], - "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", + "related": "", "response": [ { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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 vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the domain path associated with the static route", + "name": "domainpath", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "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", + "description": "the list of resource tags associated with static route", + "name": "tags", "response": [ { - "description": "the domain name of the security group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "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", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name of the group", + "description": "the project name where tag belongs to", "name": "project", "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 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": "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", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the security group", + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the ID of the domain associated with the tag", "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": "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "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 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 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" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "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 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 code for the ICMP message response", - "name": "icmpcode", - "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": "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 project name where tag belongs to", - "name": "project", - "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 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" - } - ], - "type": "set" - }, - { - "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": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" - } - ], - "type": "set" + "description": "resource type", + "name": "resourcetype", + "type": "string" } ], - "type": "set" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", "type": "list" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "VPC gateway the route is created for", + "name": "vpcgatewayid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "IP of VPC gateway the route is created for", + "name": "vpcgatewayip", "type": "string" }, - {}, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Next hop of the static route", + "name": "nexthop", "type": "string" }, + {}, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the account associated with the static route", + "name": "account", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the state of the static route", + "name": "state", "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 associated with the static route", + "name": "domainid", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the domain associated with the static route", + "name": "domain", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "VPC the static route belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project name of the static route", + "name": "project", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "static route CIDR", + "name": "cidr", "type": "string" }, { @@ -26741,753 +25800,559 @@ "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 control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the ID of static route", + "name": "id", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project id of the static route", + "name": "projectid", "type": "string" }, + {} + ] + }, + { + "description": "Returns SAML2 CloudStack Service Provider MetaData", + "isasync": false, + "name": "getSPMetadata", + "params": [], + "related": "", + "response": [ { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "The Metadata XML", + "name": "metadata", "type": "string" }, + {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "Lists all public ip addresses", + "isasync": false, + "name": "listPublicIpAddresses", + "params": [ { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" + "description": "lists IP address by ID", + "length": 255, + "name": "id", + "related": "associateIpAddress,reserveIpAddress,listPublicIpAddresses,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" + "description": "lists all public IP addresses associated to the network specified", + "length": 255, + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": false, + "type": "uuid" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" + "description": "list only static NAT IP addresses", + "length": 255, + "name": "isstaticnat", + "required": false, + "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "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": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "lists all public IP addresses by zone ID", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "true if range is dedicated for external network provider", + "length": 255, + "name": "forprovider", + "required": false, + "since": "4.21.0", + "type": "boolean" }, { - "description": "the virtual network for the service offering", + "description": "the virtual network for the IP address", + "length": 255, "name": "forvirtualnetwork", + "required": false, "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", + "required": false, + "type": "boolean" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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": "the ID of the domain in which the virtual machine 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": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "lists all public IP addresses by physical network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "lists all public IP addresses by VLAN ID", + "length": 255, + "name": "vlanid", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "required": false, + "type": "uuid" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "limits search results to allocated public IP addresses", + "length": 255, + "name": "allocatedonly", + "required": false, + "type": "boolean" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "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": "list only source NAT IP addresses", + "length": 255, + "name": "issourcenat", + "required": false, + "type": "boolean" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "true if range is dedicated for system VMs", + "length": 255, + "name": "forsystemvms", + "required": false, + "since": "4.20.0", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "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": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "List IPs belonging to the VPC", + "length": 255, + "name": "vpcid", + "related": "createVPC,listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": false, + "type": "uuid" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "lists the specified IP address", + "length": 255, + "name": "ipaddress", + "required": false, "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "lists all public IP addresses by state", + "length": 255, + "name": "state", + "required": false, + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "list only IPs used for load balancing", + "length": 255, + "name": "forloadbalancing", + "required": false, + "type": "boolean" + } + ], + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "response": [ + { + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "VPC id the ip belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", + "name": "issystem", + "type": "boolean" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { - "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, + {}, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "is public IP portable across the zones", + "name": "isportable", + "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": "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": "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 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": "customer associated with the tag", - "name": "customer", - "type": "string" - }, - { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - } - ], - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the account the public IP address is associated with", + "name": "account", "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 Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the name of the Network where ip belongs to", + "name": "networkname", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", + "name": "virtualmachinedisplayname", "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 name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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 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": "the name of the corresponding network", - "name": "networkname", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "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 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": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" - }, - { - "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": "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "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": "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": "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 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 ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "the list of resource tags associated with ip address", + "name": "tags", "response": [ { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "path of the Domain associated with the tag", + "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "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 description of the affinity group", - "name": "description", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "set" - }, - { - "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" + "type": "list" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "VPC name the ip belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "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": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" } ] }, { - "description": "Generate DRS plan for a cluster", + "description": "Lists OpenDyalight controllers", "isasync": false, - "name": "generateClusterDrsPlan", + "name": "listOpenDaylightControllers", "params": [ { - "description": "the ID of the Cluster", + "description": "the ID of a OpenDaylight Controller", "length": 255, "name": "id", - "related": "addCluster,updateCluster", - "required": true, + "related": "addOpenDaylightController,deleteOpenDaylightController,listOpenDaylightControllers", + "required": false, "type": "uuid" }, { - "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", + "description": "the Physical Network ID", "length": 255, - "name": "migrations", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" } ], - "related": "executeClusterDrsPlan", + "related": "addOpenDaylightController,deleteOpenDaylightController", "response": [ {}, { - "description": "Id of the cluster", - "name": "clusterid", - "type": "string" - }, - { - "description": "unique ID of the drs plan for cluster", + "description": "device id of the controller", "name": "id", "type": "string" }, { - "description": "Type of DRS Plan (Automated or Manual))", - "name": "type", - "type": "type" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, { - "description": "List of migrations", - "name": "migrations", - "type": "list" + "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", @@ -27495,385 +26360,440 @@ "type": "integer" }, { - "description": "Status of DRS Plan", - "name": "status", - "type": "status" + "description": "the url of the controller api", + "name": "url", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, {} - ], - "since": "4.19.0" + ] }, { - "description": "Deletes a user for an account", - "isasync": false, - "name": "deleteUser", + "description": "Adds a BigSwitch BCF Controller device", + "isasync": true, + "name": "addBigSwitchBcfDevice", "params": [ { - "description": "id of the user to be deleted", + "description": "NAT support of the BigSwitch BCF Controller.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "nat", "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" + "type": "boolean" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Hostname of ip address of the BigSwitch BCF Controller.", + "length": 255, + "name": "hostname", + "required": true, "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } - ] - }, - { - "description": "Initiates the specified power action to the host's out-of-band management interface", - "isasync": true, - "name": "issueOutOfBandManagementPowerAction", - "params": [ - { - "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", + "description": "the Physical Network ID", "length": 255, - "name": "action", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", + "description": "Password of the BigSwitch BCF Controller.", "length": 255, - "name": "timeout", - "required": false, - "type": "long" + "name": "password", + "required": true, + "type": "string" }, { - "description": "the ID of the host", + "description": "Username of the BigSwitch BCF Controller.", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], - "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "related": "listBigSwitchBcfDevices", "response": [ { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "description": "true if out-of-band management is enabled for the host", - "name": "enabled", + "description": "NAT support", + "name": "nat", "type": "boolean" }, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" - }, - { - "description": "the out-of-band management interface port", - "name": "port", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - { - "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 out-of-band management interface address", - "name": "address", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "bigswitchdevicename", "type": "string" }, { - "description": "the out-of-band management interface username", + "description": "the controller username", "name": "username", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "description": "name of the provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "description": "the controller password", + "name": "password", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", + "description": "the physical network to which this BigSwitch BCF segment belongs to", + "name": "physicalnetworkid", "type": "string" }, - {}, { - "description": "the out-of-band management interface powerState of the host", - "name": "powerstate", - "type": "powerstate" + "description": "the controller Ip address", + "name": "hostname", + "type": "string" } ], - "since": "4.9.0" + "since": "4.6.0" }, { - "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "description": "Changes the default NIC on a VM", "isasync": true, - "name": "createSharedFileSystem", + "name": "updateDefaultNicForVirtualMachine", "params": [ { - "description": "the project associated with the shared filesystem. Mutually exclusive with account parameter", + "description": "NIC ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, + "name": "nicid", + "related": "listNics", + "required": true, "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.", + "description": "Virtual Machine ID", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "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,createVMFromBackup,createVMFromBackup,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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "response": [ { - "description": "the description for the shared filesystem.", - "length": 255, - "name": "description", - "required": false, + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "max iops", - "length": 255, - "name": "maxiops", - "required": false, - "type": "long" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "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, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "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" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the name of the shared filesystem.", - "length": 255, - "name": "name", - "required": true, - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the size of the shared filesystem in GiB", - "length": 255, - "name": "size", - "required": false, - "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 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, + "description": "User VM type", + "name": "vmtype", "type": "string" }, + {}, { - "description": "the zone id.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "min iops", - "length": 255, - "name": "miniops", - "required": false, + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", - "length": 255, - "name": "filesystem", - "required": true, - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, - { - "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - } - ], - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "response": [ {}, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "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": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", "type": "boolean" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "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 state of the shared filesystem", - "name": "state", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { - "description": "service offering for the shared filesystem", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "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 template for the virtual machine", + "name": "templatename", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", "name": "serviceofferingname", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "the project id of the vm", + "name": "projectid", + "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": "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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "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 list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -27882,90 +26802,146 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "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 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": "id of the resource", - "name": "resourceid", + "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": "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" }, { - "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 list of nics associated with the shared filesystem", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + {}, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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": "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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 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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -27974,23 +26950,53 @@ "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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 nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -27998,6 +27004,21 @@ "name": "virtualmachineid", "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, { "description": "Type of adapter if available", "name": "adaptertype", @@ -28009,8 +27030,13 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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" }, { @@ -28019,161 +27045,510 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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 domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the nic", + "description": "the ID of the security group", "name": "id", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "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", + "response": [ + { + "description": "id of the resource", + "name": "resourceid", + "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": "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": "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" + } + ], + "type": "set" + }, + { + "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 type of the ICMP message response", + "name": "icmptype", + "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "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 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 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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "resource type", + "name": "resourcetype", + "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": "the domain associated with the tag", + "name": "domain", + "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": "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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", + "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": "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" } ], - "type": "list" + "type": "set" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "name of the storage fs data volume", - "name": "volumename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the shared filesystem'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 ID of the affinity group", + "name": "domainid", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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 type of the affinity group", + "name": "type", + "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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "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 domain associated with the shared filesystem", - "name": "domain", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -28182,122 +27557,68 @@ "type": "integer" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Deletes network device.", - "isasync": false, - "name": "deleteNetworkDevice", - "params": [ - { - "description": "Id of network device to delete", - "length": 255, - "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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": "Updates image store read-only status", - "isasync": false, - "name": "updateImageStore", - "params": [ + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, { - "description": "The new name for the Image Store.", - "length": 255, - "name": "name", - "required": false, + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Image Store UUID", - "length": 255, + "description": "the ID of the virtual machine", "name": "id", - "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", - "required": true, - "type": "uuid" + "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": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "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 url of the image store", - "name": "url", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the scope of the image store", - "name": "scope", - "type": "scopetype" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "defines if store is read-only", - "name": "readonly", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -28306,192 +27627,254 @@ "type": "boolean" }, { - "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" } - ], - "since": "4.15.0" + ] }, { - "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", - "isasync": true, - "name": "assignToLoadBalancerRule", + "description": "Generate DRS plan for a cluster", + "isasync": false, + "name": "generateClusterDrsPlan", "params": [ { - "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", + "description": "the ID of the Cluster", "length": 255, - "name": "vmidipmap", - "required": false, - "since": "4.4", - "type": "map" + "name": "id", + "related": "addCluster,updateCluster", + "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)", + "description": "Maximum number of VMs to migrate for a DRS execution. Defaults to value of cluster's drs.vm.migrations setting", "length": 255, - "name": "virtualmachineids", - "related": "assignVirtualMachine,migrateVirtualMachine,migrateVirtualMachineWithVolume,recoverVirtualMachine,attachIso,detachIso,deployVirtualMachine,destroyVirtualMachine,listVirtualMachines,scaleVirtualMachine,rebootVirtualMachine,removeNicFromVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,resetUserDataForVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,updateVMAffinityGroup,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importUnmanagedInstance,importVm", + "name": "migrations", "required": false, - "type": "list" - }, + "type": "integer" + } + ], + "related": "executeClusterDrsPlan", + "response": [ { - "description": "the ID of the load balancer rule", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "List of migrations", + "name": "migrations", + "type": "list" + }, + { + "description": "Status of DRS Plan", + "name": "status", + "type": "status" + } + ], + "since": "4.19.0" + }, + { + "description": "Deletes a user for an account", + "isasync": false, + "name": "deleteUser", + "params": [ + { + "description": "id of the user to be deleted", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createIpv6FirewallRule,updateIpv6FirewallRule", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, { - "description": "Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools", + "description": "Initiates the specified power action to the host's out-of-band management interface", "isasync": true, - "name": "configureStorageAccess", + "name": "issueOutOfBandManagementPowerAction", "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", + "description": "out-of-band management power actions, valid actions are: ON, OFF, CYCLE, RESET, SOFT, STATUS", "length": 255, - "name": "storageaccessgroups", - "required": false, - "since": "4.21.0", - "type": "list" + "name": "action", + "required": true, + "type": "string" }, { - "description": "UUID of the Storage Pool", + "description": "the ID of the host", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": true, "type": "uuid" }, { - "description": "UUID of the pod", + "description": "optional operation timeout in seconds that overrides the global or cluster-level out-of-band management timeout setting", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "timeout", "required": false, - "type": "uuid" + "type": "long" + } + ], + "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,enableOutOfBandManagementForCluster,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", + "response": [ + {}, + { + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" }, { - "description": "UUID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the out-of-band management action (if issued)", + "name": "action", + "type": "string" }, + {}, { - "description": "UUID of the zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "type": "uuid" - } - ], - "response": [ + "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the operation result description", + "name": "description", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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 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", + "type": "string" + }, + { + "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": "the out-of-band management interface username", + "name": "username", + "type": "string" } ], - "since": "4.21.0" + "since": "4.9.0" }, { - "description": "Lists all pending asynchronous jobs for the account.", - "isasync": false, - "name": "listAsyncJobs", + "description": "Create a new Shared File System of specified size and disk offering, attached to the given network", + "isasync": true, + "name": "createSharedFileSystem", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "the filesystem format (XFS / EXT4) which will be installed on the shared filesystem.", + "length": 255, + "name": "filesystem", + "required": true, + "type": "string" + }, + { + "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, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -28499,106 +27882,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": "the project associated with the shared filesystem. Mutually exclusive with account parameter", "length": 255, - "name": "listall", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "max iops", "length": 255, - "name": "keyword", + "name": "maxiops", "required": false, + "type": "long" + }, + { + "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": "the name of the shared filesystem.", + "length": 255, + "name": "name", + "required": true, "type": "string" }, { - "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", + "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": "startdate", - "required": false, - "type": "date" + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the size of the shared filesystem in GiB", + "length": 255, + "name": "size", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the zone id.", "length": 255, - "name": "account", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + }, + { + "description": "min iops", + "length": 255, + "name": "miniops", "required": false, - "type": "string" + "type": "long" }, { - "description": "", + "description": "the description for the shared filesystem.", "length": 255, - "name": "page", + "name": "description", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The id of the management server", + "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": "managementserverid", - "related": "listManagementServers", + "name": "provider", "required": false, - "since": "4.19", - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the account associated with the shared filesystem. Must be used with the domainId parameter.", "length": 255, - "name": "pagesize", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], - "related": "queryAsyncJobResult", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" }, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" }, - {}, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the unique ID of the instance/entity object related to the job", - "name": "jobinstanceid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "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" }, { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "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": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "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", @@ -28606,123 +28064,364 @@ "type": "integer" }, { - "description": "the async command executed", - "name": "cmd", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, + { + "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": "description of the shared filesystem", + "name": "description", + "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 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 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 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 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, + {}, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the result reason", - "name": "jobresult", - "type": "responseobject" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" - } - ] - }, - { - "description": "Archive one or more alerts.", - "isasync": false, - "name": "archiveAlerts", - "params": [ + }, { - "description": "the IDs of the alerts", - "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", - "required": false, - "type": "list" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "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": "enddate", - "required": false, - "type": "date" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "archive by alert type", - "length": 255, - "name": "type", - "required": false, + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "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": "startdate", - "required": false, - "type": "date" - } - ], - "response": [ - {}, - {}, + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "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": "MTU configured on the NIC", + "name": "mtu", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "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": "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 nic", + "name": "id", + "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 IPv6 address of network", + "name": "ip6address", + "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": "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 ip address of the nic", + "name": "ipaddress", + "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" + } + ], + "type": "list" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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": "ID of the storage fs vm", + "name": "vmstate", + "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": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Deletes a Cisco Vnmc controller", + "description": "Deletes network device.", "isasync": false, - "name": "deleteCiscoVnmcResource", + "name": "deleteNetworkDevice", "params": [ { - "description": "Cisco Vnmc resource ID", + "description": "Id of network device to delete", "length": 255, - "name": "resourceid", - "related": "addCiscoVnmcResource,listCiscoVnmcResources", + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } @@ -28734,179 +28433,175 @@ "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": "Creates a secondary storage selector, described by the heuristic rule.", + "description": "Updates image store read-only status", "isasync": false, - "name": "createSecondaryStorageSelector", + "name": "updateImageStore", "params": [ { - "description": "The name identifying the heuristic rule.", + "description": "If set to true, it designates the corresponding image store to read-only, hence not considering them during storage migration", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "readonly", + "required": false, + "type": "boolean" }, { - "description": "The description of the heuristic rule.", + "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": "description", - "required": true, - "type": "string" + "name": "capacitybytes", + "required": false, + "type": "long" }, { - "description": "The zone in which the heuristic rule will be applied.", + "description": "Image Store UUID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "id", + "related": "addSecondaryStorage,addSwift,listSwifts,updateImageStore,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "required": true, "type": "uuid" }, { - "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.", + "description": "The new name for the Image Store.", "length": 255, - "name": "type", - "required": true, + "name": "name", + "required": false, "type": "string" } ], - "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores,updateCloudToUseObjectStore", "response": [ - {}, { - "description": "When the heuristic was removed.", - "name": "removed", - "type": "date" + "description": "the Zone name of the image store", + "name": "zonename", + "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "The zone which the heuristic is valid upon.", - "name": "zoneid", + "description": "the name of the image store", + "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", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", - "name": "heuristicrule", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" + "description": "the provider name of the image store", + "name": "providername", + "type": "string" }, { "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "Name of the heuristic.", - "name": "name", - "type": "string" + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "Description of the heuristic.", - "name": "description", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" } ], - "since": "4.19.0" + "since": "4.15.0" }, { - "description": "Adds a Brocade VCS Switch", + "description": "Assigns virtual machine or a list of virtual machines to a load balancer rule.", "isasync": true, - "name": "addBrocadeVcsDevice", + "name": "assignToLoadBalancerRule", "params": [ { - "description": "Credentials to access the Brocade VCS Switch API", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "the Physical Network ID", + "description": "the ID of the load balancer rule", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "id", + "related": "createIpv6FirewallRule,updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, { - "description": "Credentials to access the Brocade VCS Switch API", + "description": "VM ID and IP map, vmidipmap[0].vmid=1 vmidipmap[0].vmip=10.1.1.75", "length": 255, - "name": "username", - "required": true, - "type": "string" + "name": "vmidipmap", + "required": false, + "since": "4.4", + "type": "map" }, { - "description": "Hostname of ip address of the Brocade VCS Switch.", + "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": "hostname", - "required": true, - "type": "string" + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": false, + "type": "list" } ], - "related": "listBrocadeVcsDevices", "response": [ - {}, - { - "description": "name of the provider", - "name": "provider", - "type": "string" - }, - { - "description": "device name", - "name": "brocadedevicename", - "type": "string" - }, { - "description": "the principal switch Ip address", - "name": "hostname", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the physical Network to which this Brocade VCS belongs to", - "name": "physicalnetworkid", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { @@ -28914,98 +28609,414 @@ "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", - "type": "string" } ] }, { - "description": "Deleting resource tag(s)", + "description": "Configure the storage access groups on zone/pod/cluster/host and storage, accordingly connections to the storage pools", "isasync": true, - "name": "deleteTags", + "name": "configureStorageAccess", "params": [ { - "description": "Delete tags for resource id(s)", + "description": "UUID of the host", "length": 255, - "name": "resourceids", - "required": true, - "type": "list" + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", + "required": false, + "type": "uuid" }, { - "description": "Delete tags matching key/value pairs", + "description": "UUID of the cluster", "length": 255, - "name": "tags", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "Delete tag by resource type", + "description": "UUID of the zone", "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" - } - ], - "response": [ - {}, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" + "description": "UUID of the pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "type": "uuid" }, { - "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 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" + } + ], + "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.0.0" + "since": "4.21.0" }, { - "description": "create Tungsten-Fabric tag type", - "isasync": true, - "name": "createTungstenFabricTagType", + "description": "Lists all pending asynchronous jobs for the account.", + "isasync": false, + "name": "listAsyncJobs", "params": [ { - "description": "the ID of zone", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric tag type name", + "description": "The start date of the async job (use format \"yyyy-MM-dd'T'HH:mm:ss'+'SSSS\")", "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "listTungstenFabricTagType", - "response": [ + "name": "startdate", + "required": false, + "type": "date" + }, { - "description": "Tungsten-Fabric tag type name", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "The id of the management server", + "length": 255, + "name": "managementserverid", + "related": "listManagementServers", + "required": false, + "since": "4.19", + "type": "uuid" + }, + { + "description": "", + "length": 255, + "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" + }, + { + "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,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + } + ], + "related": "queryAsyncJobResult", + "response": [ + { + "description": "the account that executed the async command", + "name": "account", + "type": "string" + }, + { + "description": "the domain id that executed the async command", + "name": "domainid", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": " the created date of the job", + "name": "created", + "type": "date" + }, + { + "description": "the user that executed the async command", + "name": "userid", + "type": "string" + }, + { + "description": "the result type", + "name": "jobresulttype", + "type": "string" + }, + { + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", + "type": "string" + }, + { + "description": "the account id that executed the async command", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain that executed the async command", + "name": "domainpath", + "type": "string" + }, + { + "description": "the result reason", + "name": "jobresult", + "type": "responseobject" + }, + {}, + { + "description": "the unique ID of the instance/entity object related to the job", + "name": "jobinstanceid", + "type": "string" + }, + { + "description": "the async command executed", + "name": "cmd", + "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 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 completed date of the job", + "name": "completed", + "type": "date" + }, + { + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", + "type": "string" + }, + {} + ] + }, + { + "description": "Archive one or more alerts.", + "isasync": false, + "name": "archiveAlerts", + "params": [ + { + "description": "archive by alert type", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, + { + "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": "enddate", + "required": false, + "type": "date" + }, + { + "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": "startdate", + "required": false, + "type": "date" + }, + { + "description": "the IDs of the alerts", + "length": 255, + "name": "ids", + "related": "listAlerts,listAlertTypes", + "required": false, + "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", + "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": "Deletes a Cisco Vnmc controller", + "isasync": false, + "name": "deleteCiscoVnmcResource", + "params": [ + { + "description": "Cisco Vnmc resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoVnmcResource,listCiscoVnmcResources", + "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": "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": "Creates a secondary storage selector, described by the heuristic rule.", + "isasync": false, + "name": "createSecondaryStorageSelector", + "params": [ + { + "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": "type", + "required": true, + "type": "string" + }, + { + "description": "The name identifying the heuristic rule.", + "length": 255, "name": "name", + "required": true, + "type": "string" + }, + { + "description": "The description of the heuristic rule.", + "length": 255, + "name": "description", + "required": true, + "type": "string" + }, + { + "description": "The zone in which the heuristic rule will be applied.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" + } + ], + "related": "listSecondaryStorageSelectors,updateSecondaryStorageSelector", + "response": [ + { + "description": "Description of the heuristic.", + "name": "description", + "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" }, { @@ -29013,27 +29024,229 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "ID of the heuristic.", + "name": "id", + "type": "string" + }, + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + }, + { + "description": "When the heuristic was created.", + "name": "created", + "type": "date" + }, {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, + {}, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "The zone which the heuristic is valid upon.", + "name": "zoneid", + "type": "string" + } + ], + "since": "4.19.0" + }, + { + "description": "Adds a Brocade VCS Switch", + "isasync": true, + "name": "addBrocadeVcsDevice", + "params": [ + { + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Credentials to access the Brocade VCS Switch API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, + { + "description": "Hostname of ip address of the Brocade VCS Switch.", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": true, + "type": "uuid" + } + ], + "related": "listBrocadeVcsDevices", + "response": [ + { + "description": "device id of the Brocade Vcs", + "name": "vcsdeviceid", + "type": "string" + }, {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "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", + "name": "physicalnetworkid", + "type": "string" + }, + {}, + { + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "description": "the principal switch Ip address", + "name": "hostname", + "type": "string" + }, + { + "description": "device name", + "name": "brocadedevicename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } + ] + }, + { + "description": "Deleting resource tag(s)", + "isasync": true, + "name": "deleteTags", + "params": [ + { + "description": "Delete tags for resource id(s)", + "length": 255, + "name": "resourceids", + "required": true, + "type": "list" + }, + { + "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": "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.0.0" + }, + { + "description": "create Tungsten-Fabric tag type", + "isasync": true, + "name": "createTungstenFabricTagType", + "params": [ + { + "description": "Tungsten-Fabric tag type 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" + } + ], + "related": "listTungstenFabricTagType", + "response": [ + { + "description": "Tungsten-Fabric tag type 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": "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 tag type name", + "name": "name", + "type": "string" } ] }, @@ -29049,14 +29262,6 @@ "required": false, "type": "boolean" }, - { - "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": "Live patches the router software before restarting it. This parameter will only work when 'cleanup' is false.", "length": 255, @@ -29065,6 +29270,14 @@ "since": "4.17.0", "type": "boolean" }, + { + "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, @@ -29075,28 +29288,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", + "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" + } ] }, { @@ -29105,89 +29318,95 @@ "name": "login", "params": [ { - "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": "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": "password", - "required": true, + "name": "domain", + "required": false, "type": "string" }, { - "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": "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": "domain", - "required": false, - "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.", "length": 255, "name": "domainId", "required": false, "type": "long" + }, + { + "description": "Username", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], - "related": "oauthlogin", + "related": "samlSso,oauthlogin", "response": [ { - "description": "Username", - "name": "username", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "the account name the user belongs to", - "name": "account", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "user time zone", + "name": "timezone", "type": "string" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "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": "user time zone", - "name": "timezone", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "user time zoneoffset", + "name": "timezoneoffset", "type": "string" }, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "User ID", - "name": "userid", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the time period before the session has expired", - "name": "timeout", + "description": "Is user registered", + "name": "registered", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "user time zoneoffset", - "name": "timezoneoffset", + "description": "the account name the user belongs to", + "name": "account", "type": "string" }, { @@ -29195,41 +29414,35 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "Domain ID that the user belongs to", - "name": "domainid", - "type": "string" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "User ID", + "name": "userid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, { - "description": "last name of the user", - "name": "lastname", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "first name of the user", - "name": "firstname", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" } ] @@ -29247,23 +29460,23 @@ "type": "string" }, { - "description": "the hypervisor for which to restrict the search", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "pagesize", + "name": "hypervisor", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -29279,50 +29492,50 @@ "related": "", "response": [ { - "description": "the hypervisor type", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the maximum number of Hosts per cluster for this hypervisor", - "name": "maxhostspercluster", - "type": "integer" + "description": "true if storage motion is supported", + "name": "storagemotionenabled", + "type": "boolean" }, { - "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": "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 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", + "description": "the maximum number of Data Volumes that can be attached for this hypervisor", + "name": "maxdatavolumeslimit", + "type": "integer" + }, + { + "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 hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { "description": "true if security group is supported", @@ -29330,8 +29543,8 @@ "type": "boolean" }, { - "description": "true if storage motion is supported", - "name": "storagemotionenabled", + "description": "true if VM snapshots are enabled for this hypervisor", + "name": "vmsnapshotenabled", "type": "boolean" }, {} @@ -29362,9 +29575,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": "any text associated with the success or failure", @@ -29376,13 +29589,13 @@ "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.15.0" }, @@ -29401,11 +29614,10 @@ ], "related": "", "response": [ - {}, {}, { - "description": "variable", - "name": "variable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -29413,14 +29625,15 @@ "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", + "description": "variable", + "name": "variable", "type": "string" } ], @@ -29432,11 +29645,18 @@ "name": "quotaBalance", "params": [ { - "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "Account Id for which statement needs to be generated", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "account", "required": true, + "type": "string" + }, + { + "description": "List usage records for the specified account", + "length": 255, + "name": "accountid", + "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" }, { @@ -29447,11 +29667,11 @@ "type": "date" }, { - "description": "List usage records for the specified account", + "description": "If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "accountid", - "related": "createAccount,disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": true, "type": "uuid" }, { @@ -29460,47 +29680,25 @@ "name": "startdate", "required": false, "type": "date" - }, - { - "description": "Account Id for which statement needs to be generated", - "length": 255, - "name": "account", - "required": true, - "type": "string" } ], "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "quota consumed", - "name": "quota", - "type": "bigdecimal" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "usage type", + "name": "type", + "type": "int" }, { "description": "account id", @@ -29514,9 +29712,24 @@ }, {}, { - "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": "quota consumed", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "usage type name", + "name": "name", "type": "string" + }, + { + "description": "domain id", + "name": "domain", + "type": "long" } ], "since": "4.7.0" @@ -29527,16 +29740,16 @@ "name": "getSolidFireAccountId", "params": [ { - "description": "Storage Pool UUID", + "description": "CloudStack Account UUID", "length": 255, - "name": "storageid", + "name": "accountid", "required": true, "type": "string" }, { - "description": "CloudStack Account UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "accountid", + "name": "storageid", "required": true, "type": "string" } @@ -29544,16 +29757,16 @@ "related": "", "response": [ { - "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": "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", @@ -29579,47 +29792,47 @@ "related": "", "response": [ { - "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", + "description": "the name of the role to which the role permission belongs", + "name": "rolename", "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", + "description": "the description of the role permission", + "name": "description", "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" }, - {}, { - "description": "the ID of the role to which the role permission belongs", - "name": "roleid", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "description": "the ID of the role permission", + "name": "id", "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {} + { + "description": "the ID of the role to which the role permission belongs", + "name": "roleid", + "type": "string" + } ], "since": "4.9.0" }, @@ -29628,6 +29841,13 @@ "isasync": false, "name": "listDedicatedGuestVlanRanges", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the dedicated guest vlan range", "length": 255, @@ -29636,27 +29856,27 @@ "type": "string" }, { - "description": "zone of the guest VLAN range", + "description": "physical network id of the guest VLAN range", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" }, { - "description": "list dedicated guest vlan ranges by id", + "description": "", "length": 255, - "name": "id", - "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", + "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", "length": 255, - "name": "account", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { "description": "project who will own the guest VLAN range", @@ -29667,106 +29887,99 @@ "type": "uuid" }, { - "description": "physical network id of the guest VLAN range", + "description": "list dedicated guest vlan ranges by id", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "id", + "related": "dedicateGuestVlanRange,listDedicatedGuestVlanRanges", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the domain ID with which the guest VLAN range is associated. If used with the account parameter, returns all guest VLAN ranges for that account in the specified domain.", + "description": "zone of the guest VLAN range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "the account with which the guest VLAN range is associated. Must be used with the domainId parameter.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" } ], "related": "dedicateGuestVlanRange", "response": [ { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the account of the guest VLAN range", + "name": "account", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { - "description": "path of the domain to which the guest VLAN range belongs", - "name": "domainpath", + "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 domain name of the guest VLAN range", + "name": "domain", "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", "name": "jobstatus", "type": "integer" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain ID of the guest VLAN range", - "name": "domainid", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, - {}, { - "description": "the ID of the guest VLAN range", - "name": "id", + "description": "path of the domain to which the guest VLAN range belongs", + "name": "domainpath", "type": "string" }, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" - }, - { - "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 guest VLAN range", - "name": "guestvlanrange", - "type": "string" } ] }, @@ -29775,20 +29988,6 @@ "isasync": false, "name": "listNetworkACLs", "params": [ - { - "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 network ACL items by action", - "length": 255, - "name": "action", - "required": false, - "type": "string" - }, { "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, @@ -29797,18 +29996,10 @@ "type": "string" }, { - "description": "list network ACL items by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "Lists network ACL Item with the specified ID", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", "required": false, "type": "uuid" }, @@ -29820,63 +30011,62 @@ "type": "map" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Lists network ACL Item with the specified ID", + "description": "list network ACL items by traffic type - ingress or egress", "length": 255, - "name": "id", - "related": "createNetworkACL,listNetworkACLs,updateNetworkACLItem,moveNetworkAclItem", + "name": "traffictype", "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": "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 display flag; only ROOT admin is eligible to pass this parameter", + "description": "list network ACL items by action", "length": 255, - "name": "fordisplay", + "name": "action", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list network ACL items by traffic type - ingress or egress", + "description": "list network ACL items by network ID", "length": 255, - "name": "traffictype", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listNiciraNvpDeviceNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list network ACL items by protocol", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "protocol", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "list network ACL items by ACL ID", @@ -29886,30 +30076,42 @@ "required": false, "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": "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 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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" } ], "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", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -29917,69 +30119,34 @@ "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", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "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": "customer associated with the tag", - "name": "customer", + "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 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" }, { @@ -29988,8 +30155,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -29998,52 +30170,93 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { "description": "resource type", "name": "resourcetype", "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" } ], "type": "list" }, { - "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 protocol of the ACL", + "name": "protocol", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", + "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", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "the traffic type for the ACL", + "name": "traffictype", + "type": "string" + }, + { + "description": "the starting port of ACL's port range", + "name": "startport", + "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": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" + }, + {}, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" } ] }, @@ -30053,17 +30266,17 @@ "name": "copyTemplate", "params": [ { - "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": "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": "destzoneid", + "name": "sourcezoneid", "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" @@ -30080,42 +30293,41 @@ "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", + "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" } ], - "related": "prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,registerIso,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "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 name of the OS type for this template.", - "name": "ostypename", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, - {}, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -30124,33 +30336,39 @@ "type": "boolean" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the account name to which the template belongs", - "name": "account", - "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", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "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 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 ID of the domain to which the template belongs", - "name": "domainid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { @@ -30159,67 +30377,83 @@ "type": "map" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "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 list of resource tags associated", "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": "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -30233,154 +30467,148 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "tag value", - "name": "value", + "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" } ], "type": "set" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, - {}, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "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": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "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 project id of the template", - "name": "projectid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, + {}, { - "description": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the type of the template", + "name": "templatetype", + "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 URL which the template/iso is registered from", + "name": "url", "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 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 template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, - {}, { - "description": "the template name", - "name": "name", - "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 status of the template", - "name": "status", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { "description": "path of the Domain the template belongs to", @@ -30388,58 +30616,43 @@ "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "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", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "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 ID of the zone for this template", + "name": "zoneid", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "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": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "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" } ] @@ -30452,7 +30665,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -30463,13 +30676,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "nicira nvp device ID", "length": 255, @@ -30477,29 +30683,50 @@ "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ - {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "the name of the zone the network belongs to", + "name": "zonename", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { @@ -30508,108 +30735,211 @@ "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "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": "related to what other network configuration", + "name": "related", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "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": "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 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": "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, + {}, { - "description": "acl type - access type to the network", - "name": "acltype", + "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", "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": "state of the network", + "name": "state", "type": "string" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "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": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "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 supports specifying vlan, false otherwise", - "name": "specifyvlan", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, + { + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, { "description": "list networks available for vm deployment", "name": "canusefordeploy", "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 IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "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 uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "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": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -30617,10 +30947,24 @@ "name": "privatemtu", "type": "integer" }, - {}, { - "description": "the network's netmask", - "name": "netmask", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", + "type": "string" + }, + { + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { @@ -30628,29 +30972,36 @@ "name": "service", "response": [ { - "description": "the service provider name", - "name": "provider", + "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": "state of the network provider", - "name": "state", + "description": "the capability value", + "name": "value", "type": "string" }, { - "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" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ { "description": "services for this provider", "name": "servicelist", @@ -30662,146 +31013,114 @@ "type": "boolean" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "state of the network provider", + "name": "state", "type": "string" - } - ], - "type": "list" - }, - { - "description": "the list of capabilities", - "name": "capability", - "response": [ + }, { - "description": "the capability value", - "name": "value", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" } ], "type": "list" }, { - "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", - "name": "zonesnetworkspans", - "type": "set" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "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": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "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 second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "description": "the id of the network", - "name": "id", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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 project name of the address", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", "type": "set" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "The external id of the network", - "name": "externalid", - "type": "string" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { @@ -30810,8 +31129,8 @@ "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { @@ -30820,191 +31139,85 @@ "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" }, + {}, { "description": "the physical network id", "name": "physicalnetworkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "type": "string" - }, - { - "description": "the list of resource tags associated with network", - "name": "tags", - "response": [ - { - "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": "the account associated with the tag", - "name": "account", - "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": "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" - } - ], - "type": "list" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", - "type": "string" - }, - { - "description": "the type of the network", - "name": "type", - "type": "string" - }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "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": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the network", - "name": "name", + "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 network to the end user or not.", "name": "displaynetwork", "type": "boolean" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" } ] }, @@ -31023,28 +31236,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": "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.6.0" }, @@ -31054,34 +31267,34 @@ "name": "listOvsElements", "params": [ { - "description": "", + "description": "list network offerings by enabled state", "length": 255, - "name": "pagesize", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "list ovs elements by network service provider id", + "description": "list ovs elements by id", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "id", + "related": "listOvsElements,configureOvsElement", "required": false, "type": "uuid" }, { - "description": "list ovs elements by id", + "description": "", "length": 255, - "name": "id", - "related": "listOvsElements,configureOvsElement", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list network offerings by enabled state", + "description": "list ovs elements by network service provider id", "length": 255, - "name": "enabled", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -31101,38 +31314,33 @@ "related": "configureOvsElement", "response": [ { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the account associated with the provider", + "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 ovs", - "name": "id", + "description": "the domain associated with the provider", + "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 provider belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the provider", - "name": "domain", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -31140,23 +31348,28 @@ "name": "project", "type": "string" }, - {}, - {}, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the domain ID associated with the provider", + "name": "domainid", "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" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", + "description": "the id of the ovs", + "name": "id", "type": "string" - } + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, + {} ] }, { @@ -31165,12 +31378,11 @@ "name": "associateUcsProfileToBlade", "params": [ { - "description": "blade id", + "description": "profile dn", "length": 255, - "name": "bladeid", - "related": "associateUcsProfileToBlade", + "name": "profiledn", "required": true, - "type": "uuid" + "type": "string" }, { "description": "ucs manager id", @@ -31181,23 +31393,30 @@ "type": "uuid" }, { - "description": "profile dn", + "description": "blade id", "length": 255, - "name": "profiledn", + "name": "bladeid", + "related": "associateUcsProfileToBlade", "required": true, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "associated ucs profile dn", - "name": "profiledn", + "description": "cloudstack host id this blade associates to", + "name": "hostid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ucs blade dn", + "name": "bladedn", + "type": "string" + }, + { + "description": "associated ucs profile dn", + "name": "profiledn", "type": "string" }, { @@ -31205,29 +31424,62 @@ "name": "id", "type": "string" }, + {}, { - "description": "cloudstack host id this blade associates to", - "name": "hostid", + "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": "ucs manager id", "name": "ucsmanagerid", "type": "string" - }, + } + ] + }, + { + "description": "Checks the 2FA code for the user.", + "isasync": false, + "name": "validateUserTwoFactorAuthenticationCode", + "params": [ { - "description": "ucs blade dn", - "name": "bladedn", + "description": "two factor authentication code", + "length": 255, + "name": "codefor2fa", + "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": "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.18.0" }, { "description": "Updates a VMware datacenter details for a zone", @@ -31242,6 +31494,13 @@ "required": true, "type": "uuid" }, + { + "description": "The username required to connect to resource.", + "length": 255, + "name": "username", + "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, @@ -31256,13 +31515,6 @@ "required": false, "type": "string" }, - { - "description": "The username required to connect to resource.", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "VMware datacenter name.", "length": 255, @@ -31280,30 +31532,20 @@ ], "related": "addVmwareDc,listVmwareDcs", "response": [ + {}, { - "description": "The VMware vCenter name/ip", - "name": "vcenter", + "description": "The VMware Datacenter name", + "name": "name", "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", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "The VMware Datacenter name", - "name": "name", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "type": "string" }, {}, @@ -31311,54 +31553,32 @@ "description": "The VMware Datacenter ID", "name": "id", "type": "string" - } - ], - "since": "4.12.0" - }, - { - "description": "Checks the 2FA code for the user.", - "isasync": false, - "name": "validateUserTwoFactorAuthenticationCode", - "params": [ - { - "description": "two factor authentication code", - "length": 255, - "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" + "since": "4.12.0" }, { "description": "Starts a router.", "isasync": false, "name": "getRouterHealthCheckResults", "params": [ + { + "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" + }, { "description": "the ID of the router", "length": 255, @@ -31366,38 +31586,31 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the id of the router", - "name": "routerid", - "type": "string" + "name": "healthchecks", + "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 id of the router", - "name": "healthchecks", - "type": "list" + "name": "routerid", + "type": "string" }, + {}, {} ], "since": "4.14.0" @@ -31415,31 +31628,30 @@ "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": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "ncc_ip", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "num_retries", - "name": "numretries", + "description": "username", + "name": "username", "type": "string" }, { @@ -31447,25 +31659,26 @@ "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", + "description": "ncc_ip", + "name": "ipaddress", "type": "string" }, - {}, { "description": "id", "name": "id", "type": "string" }, + {}, { - "description": "username", - "name": "username", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "num_retries", + "name": "numretries", "type": "string" } ] @@ -31475,14 +31688,6 @@ "isasync": true, "name": "resizeVolume", "params": [ - { - "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": "the ID of the disk volume", "length": 255, @@ -31492,18 +31697,20 @@ "type": "uuid" }, { - "description": "New minimum number of IOPS", + "description": "Flag to allow automatic migration of the volume to another suitable storage pool that accommodates the new size", "length": 255, - "name": "miniops", + "name": "automigrate", "required": false, - "type": "long" + "since": "4.20.1", + "type": "boolean" }, { - "description": "Verify OK to Shrink", + "description": "new disk offering id", "length": 255, - "name": "shrinkok", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "New maximum number of IOPS", @@ -31513,17 +31720,23 @@ "type": "long" }, { - "description": "new disk offering id", + "description": "New volume size in GB", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "name": "size", "required": false, - "type": "uuid" + "type": "long" }, { - "description": "New volume size in GB", + "description": "Verify OK to Shrink", "length": 255, - "name": "size", + "name": "shrinkok", + "required": false, + "type": "boolean" + }, + { + "description": "New minimum number of IOPS", + "length": 255, + "name": "miniops", "required": false, "type": "long" } @@ -31531,48 +31744,43 @@ "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "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": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { @@ -31581,145 +31789,192 @@ "type": "long" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the availability zone", + "name": "zonename", "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": "the project name of the vpn", - "name": "project", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "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", + "description": "the date the volume was attached to a VM instance", + "name": "attached", "type": "date" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "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": "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": "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": "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": "ID of the availability zone", - "name": "zoneid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, + {}, { - "description": "name of the disk volume", - "name": "name", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "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": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "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 offering", - "name": "diskofferingname", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the chain info of the volume", + "name": "chaininfo", "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "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": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 status of the volume", + "name": "status", + "type": "string" }, { "description": "shared or local storage", @@ -31727,23 +31982,23 @@ "type": "string" }, { - "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": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { @@ -31752,207 +32007,165 @@ "type": "long" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", + "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", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "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": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "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 ID of the domain associated with the tag", - "name": "domainid", - "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": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" - } - ], - "type": "set" + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "pod name of the volume", - "name": "podname", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "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": "name of the virtual machine", - "name": "vmname", + "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", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, + {}, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "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": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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 disk volume", + "name": "name", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", + "type": "long" } ] }, @@ -31969,12 +32182,11 @@ "type": "string" }, { - "description": "The ID of the affinity group. Mutually exclusive with name parameter", + "description": "the account of the affinity group. Must be specified with domain ID", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the domain ID of account owning the affinity group", @@ -31985,32 +32197,23 @@ "type": "uuid" }, { - "description": "the account of the affinity group. Must be specified with domain ID", + "description": "the project of the affinity group", "length": 255, - "name": "account", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the project of the affinity group", + "description": "The ID of the affinity group. Mutually exclusive with name parameter", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "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": "any text associated with the success or failure", "name": "displaytext", @@ -32021,34 +32224,37 @@ "name": "jobstatus", "type": "integer" }, - {}, - {} - ] - }, - { - "description": "Add NSX Controller to CloudStack", - "isasync": false, - "name": "addNsxController", - "params": [ { - "description": "Username to log into NSX controller", - "length": 255, - "name": "username", - "required": true, + "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": "Add NSX Controller to CloudStack", + "isasync": false, + "name": "addNsxController", + "params": [ { - "description": "Edge Cluster name", + "description": "NSX controller / provider name", "length": 255, - "name": "edgecluster", + "name": "name", "required": true, "type": "string" }, { - "description": "NSX controller port", + "description": "Username to log into NSX controller", "length": 255, - "name": "nsxproviderport", - "required": false, + "name": "username", + "required": true, "type": "string" }, { @@ -32059,12 +32265,18 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Edge Cluster name", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "edgecluster", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "NSX controller port", + "length": 255, + "name": "nsxproviderport", + "required": false, + "type": "string" }, { "description": "NSX controller hostname / IP address", @@ -32081,11 +32293,12 @@ "type": "string" }, { - "description": "NSX controller / provider name", + "description": "the ID of zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Transport Zone controls to which hosts a logical switch can reach", @@ -32098,39 +32311,38 @@ "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", + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "NSX controller name", + "name": "name", "type": "string" }, { - "description": "NSX controller name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "NSX controller port", - "name": "port", + "description": "NSX controller hostname or IP address", + "name": "hostname", "type": "string" }, { - "description": "The name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", + "description": "The tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, - {}, { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "description": "NSX controller port", + "name": "port", "type": "string" }, { - "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", - "name": "transportzone", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { @@ -32138,22 +32350,23 @@ "name": "zoneid", "type": "string" }, + {}, { - "description": "Zone name to which the NSX controller is associated with", - "name": "zonename", + "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 hostname or IP address", - "name": "hostname", + "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 current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } + }, + {} ], "since": "4.19.0" }, @@ -32178,22 +32391,22 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "3.0.0" }, @@ -32203,17 +32416,16 @@ "name": "updateStorageNetworkIpRange", "params": [ { - "description": "UUID of storage network ip range", + "description": "Optional. the vlan the ip range sits on", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "integer" }, { - "description": "the ending IP address", + "description": "the netmask for storage network", "length": 255, - "name": "endip", + "name": "netmask", "required": false, "type": "string" }, @@ -32225,78 +32437,79 @@ "type": "string" }, { - "description": "Optional. the vlan the ip range sits on", + "description": "the ending IP address", "length": 255, - "name": "vlan", + "name": "endip", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the netmask for storage network", + "description": "UUID of storage network ip range", "length": 255, - "name": "netmask", - "required": false, - "type": "string" + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange,updateStorageNetworkIpRange", + "required": true, + "type": "uuid" } ], "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "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 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 netmask of the storage network IP range", - "name": "netmask", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, - {}, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the gateway of the storage network IP range", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 netmask of the storage network IP range", + "name": "netmask", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "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" }, { "description": "the Pod uuid for the storage network IP range", "name": "podid", "type": "string" + }, + { + "description": "the start ip of the storage network IP range", + "name": "startip", + "type": "string" } ], "since": "3.0.0" @@ -32307,12 +32520,11 @@ "name": "dedicatePod", "params": [ { - "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" }, { "description": "the ID of the Pod", @@ -32323,45 +32535,50 @@ "type": "uuid" }, { - "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" } ], "related": "listDedicatedPods", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, { - "description": "the Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" }, - {}, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the domain ID to which the Pod is dedicated", + "name": "domainid", "type": "string" }, { - "description": "the Account Id to which the Pod is dedicated", - "name": "accountid", + "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 Pod", - "name": "podname", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, { @@ -32369,11 +32586,7 @@ "name": "podid", "type": "string" }, - { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", - "type": "string" - } + {} ] }, { @@ -32381,13 +32594,6 @@ "isasync": false, "name": "createGpuCard", "params": [ - { - "description": "the display name of the GPU card", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the device name of the GPU card", "length": 255, @@ -32395,13 +32601,6 @@ "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, @@ -32409,6 +32608,13 @@ "required": false, "type": "long" }, + { + "description": "the display name of the GPU card", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "the vendor name of the GPU card", "length": 255, @@ -32422,51 +32628,58 @@ "name": "vendorid", "required": true, "type": "string" + }, + { + "description": "the device ID of the GPU card", + "length": 255, + "name": "deviceid", + "required": true, + "type": "string" } ], "related": "updateGpuCard,listGpuCards", "response": [ + {}, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "the display name of the GPU card", - "name": "name", + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, - {}, { "description": "the device ID of the GPU card", "name": "deviceid", "type": "string" }, + {}, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "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 device name of the GPU card", + "name": "devicename", + "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { "description": "the ID of the GPU card", "name": "id", "type": "string" - }, - { - "description": "the vendor ID of the GPU card", - "name": "vendorid", - "type": "string" } ], "since": "4.21.0" @@ -32486,28 +32699,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" - } + {}, + {} ] }, { @@ -32516,40 +32729,33 @@ "name": "listVgpuProfiles", "params": [ { - "description": "ID of the vGPU profile", - "length": 255, - "name": "id", - "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", + "description": "", "length": 255, - "name": "activeonly", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "", + "description": "ID of the vGPU profile", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile,listVgpuProfiles", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "the GPU card ID associated with this GPU device", @@ -32559,6 +32765,13 @@ "required": false, "type": "uuid" }, + { + "description": "If true, only vGPU profiles which have a device will be listed. If false, all vGPU profiles will be listed.", + "length": 255, + "name": "activeonly", + "required": false, + "type": "boolean" + }, { "description": "name of the vGPU profile", "length": 255, @@ -32570,86 +32783,86 @@ "related": "createVgpuProfile,updateVgpuProfile", "response": [ { - "description": "the name of the vGPU profile", - "name": "gpucardname", - "type": "string" - }, - {}, - {}, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the maximum number of vGPUs per physical GPU", + "name": "maxvgpuperphysicalgpu", "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 ID of the GPU card", "name": "id", "type": "string" }, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the display name of the GPU card", + "name": "name", "type": "string" }, { - "description": "the description of the vGPU profile", - "name": "description", + "description": "the device name of the GPU card", + "name": "devicename", "type": "string" }, { - "description": "the device ID of the GPU card", - "name": "deviceid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "the vendor ID of the GPU card", "name": "vendorid", "type": "string" }, + {}, { - "description": "the ID of the GPU card associated with this vGPU profile", - "name": "gpucardid", + "description": "the name of the vGPU profile", + "name": "gpucardname", "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 video RAM size in MB", - "name": "videoram", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the device name of the GPU card", - "name": "devicename", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "the maximum number of vGPUs per physical GPU", - "name": "maxvgpuperphysicalgpu", - "type": "long" + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the device ID of the GPU card", + "name": "deviceid", + "type": "string" }, { "description": "the maximum number of display heads", "name": "maxheads", "type": "long" }, + {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the description of the vGPU profile", + "name": "description", + "type": "string" } ], "since": "4.21.0" @@ -32666,13 +32879,6 @@ "required": false, "type": "long" }, - { - "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 start date range of the expunged resources used for purging (use format \"yyyy-MM-dd\" or \"yyyy-MM-dd HH:mm:ss\")", "length": 255, @@ -32686,31 +32892,38 @@ "name": "resourcetype", "required": false, "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" } ], "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", + "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" }, @@ -32720,39 +32933,32 @@ "name": "changeOfferingForVolume", "params": [ { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "type": "boolean" - }, - { - "description": "New volume size in GB for the custom disk offering", + "description": "New minimum number of IOPS for the custom disk offering", "length": 255, - "name": "size", + "name": "miniops", "required": false, "type": "long" }, { - "description": "new disk offering id", + "description": "the ID of the volume", "length": 255, - "name": "diskofferingid", - "related": "createDiskOffering,listDiskOfferings", + "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": "the ID of the volume", + "description": "new disk offering id", "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", + "name": "diskofferingid", + "related": "createDiskOffering,listDiskOfferings", "required": true, "type": "uuid" }, { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "New volume size in GB for the custom disk offering", "length": 255, - "name": "maxiops", + "name": "size", "required": false, "type": "long" }, @@ -32764,9 +32970,16 @@ "type": "boolean" }, { - "description": "New minimum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "miniops", + "name": "shrinkok", + "required": false, + "type": "boolean" + }, + { + "description": "New maximum number of IOPS for the custom disk offering", + "length": 255, + "name": "maxiops", "required": false, "type": "long" } @@ -32774,8 +32987,8 @@ "related": "attachVolume,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 template for the virtual machine", - "name": "templatename", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { @@ -32784,142 +32997,67 @@ "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", - "name": "jobid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" - }, - { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "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", - "name": "volumecheckresult", - "type": "map" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "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": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "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", - "type": "string" - }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 account associated with the tag", + "name": "account", "type": "string" }, { @@ -32928,219 +33066,247 @@ "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": "id of the resource", + "name": "resourceid", "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 project id of the vpn", - "name": "projectid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, - {}, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", + "type": "string" }, { - "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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 snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "description": "the state of the disk volume", + "name": "state", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "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 domain associated with the disk volume", - "name": "domain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "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": "name of the disk offering", - "name": "diskofferingname", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, { "description": "name of the availability zone", "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, - {}, { "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": "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": "the disk utilization", + "name": "utilization", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "type of the virtual machine", + "name": "vmtype", + "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "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": "ID of the availability zone", - "name": "zoneid", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the format of the disk encryption if applicable", @@ -33148,8 +33314,13 @@ "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -33158,28 +33329,28 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -33188,10 +33359,52 @@ "type": "boolean" }, { - "description": "the status of the volume", - "name": "status", + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + {}, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "pod id of the volume", + "name": "podid", + "type": "string" + }, + { + "description": "id of the virtual machine", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "ID of the disk volume", + "name": "id", + "type": "string" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", "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 the entity/resource has annotations", "name": "hasannotations", @@ -33206,19 +33419,20 @@ "name": "deleteLdapConfiguration", "params": [ { - "description": "linked domain", + "description": "ID of the LDAP configuration", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "addLdapConfiguration,deleteLdapConfiguration,listLdapConfigurations", "required": false, "type": "uuid" }, { - "description": "Hostname", + "description": "linked domain", "length": 255, - "name": "hostname", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "port", @@ -33226,14 +33440,25 @@ "name": "port", "required": false, "type": "integer" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], "related": "addLdapConfiguration,listLdapConfigurations", "response": [ - {}, { - "description": "linked domain", - "name": "domainid", + "description": "name of the host running the ldap server", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -33242,13 +33467,13 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the LDAP configuration", + "name": "id", "type": "string" }, { - "description": "name of the host running the ldap server", - "name": "hostname", + "description": "linked domain", + "name": "domainid", "type": "string" }, { @@ -33256,6 +33481,7 @@ "name": "port", "type": "int" }, + {}, {} ], "since": "4.2.0" @@ -33265,6 +33491,14 @@ "isasync": false, "name": "createProjectRole", "params": [ + { + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": true, + "type": "uuid" + }, { "description": "creates a project role with this unique name", "length": 255, @@ -33278,55 +33512,47 @@ "name": "description", "required": false, "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 ID of the role", - "name": "id", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, {}, { - "description": "the name of the role", - "name": "name", - "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", - "name": "description", + "description": "the ID of the role", + "name": "id", "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 id of the project", "name": "projectid", "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" - } + }, + {} ], "since": "4.15.0" }, @@ -33336,25 +33562,40 @@ "name": "createIpv6FirewallRule", "params": [ { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "The network of the VM the Ipv6 firewall rule will be created for", "length": 255, - "name": "destcidrlist", + "name": "networkid", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "description": "the starting port of Ipv6 firewall rule", + "length": 255, + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the source CIDR list to allow traffic from. 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": true, + "type": "string" + }, + { + "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 traffic type for the Ipv6 firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "error code for this ICMP message", "length": 255, - "name": "traffictype", + "name": "icmpcode", "required": false, - "type": "string" + "type": "integer" }, { "description": "type of the ICMP message being sent", @@ -33364,23 +33605,23 @@ "type": "integer" }, { - "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 protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "protocol", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "type": "list" }, { - "description": "error code for this ICMP message", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "icmpcode", + "name": "endport", "required": false, "type": "integer" }, @@ -33390,33 +33631,43 @@ "name": "fordisplay", "required": false, "type": "boolean" + } + ], + "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", + "response": [ + { + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "the starting port of Ipv6 firewall rule", - "length": 255, - "name": "startport", - "required": false, - "type": "integer" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "The network of the VM the Ipv6 firewall rule will be created for", - "length": 255, - "name": "networkid", - "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", + "type": "string" + }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "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": "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" }, { @@ -33424,33 +33675,65 @@ "name": "publicport", "type": "string" }, + {}, + { + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "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 id for the port forwarding rule", + "name": "ipaddressid", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "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 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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -33459,71 +33742,41 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "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" } ], "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", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { @@ -33531,38 +33784,11 @@ "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" - }, - {} + } ] }, { @@ -33581,6 +33807,11 @@ ], "related": "prepareForMaintenance,cancelMaintenance,prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the state of the management server", "name": "state", @@ -33596,22 +33827,6 @@ "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", @@ -33622,17 +33837,28 @@ "name": "maintenanceinitiated", "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 number of jobs in progress", - "name": "pendingjobscount", - "type": "long" - } + "description": "The id of the management server", + "name": "managementserverid", + "type": "string" + }, + {}, + {} ], "since": "4.19.0" }, @@ -33642,12 +33868,20 @@ "name": "updateNetwork", "params": [ { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the ID of the network", "length": 255, - "name": "privatemtu", + "name": "id", + "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" + }, + { + "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": "integer" + "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", @@ -33656,6 +33890,22 @@ "required": false, "type": "boolean" }, + { + "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": "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 new name for the network", "length": 255, @@ -33671,54 +33921,45 @@ "type": "boolean" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "network offering ID", "length": 255, - "name": "hideipaddressusage", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "Force update even if CIDR type is different", "length": 255, - "name": "displaynetwork", + "name": "changecidr", "required": false, "type": "boolean" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", "length": 255, - "name": "publicmtu", + "name": "guestvmcidr", "required": false, - "since": "4.18.0", - "type": "integer" - }, - { - "description": "the ID of the network", - "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,updateNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" + "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": "network domain", "length": 255, - "name": "ip6dns1", + "name": "networkdomain", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "CIDR for guest VMs, CloudStack allocates IPs to guest VMs only from this CIDR", + "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "guestvmcidr", + "name": "hideipaddressusage", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the second IPv4 DNS for the network. Empty string will update the second IPv4 DNS with the value from the zone", + "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": "dns2", + "name": "ip6dns1", "required": false, "since": "4.18.0", "type": "string" @@ -33739,168 +33980,67 @@ "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", + "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", "length": 255, - "name": "dns1", + "name": "sourcenatipaddress", "required": false, - "since": "4.18.0", + "since": "4.19", "type": "string" }, { - "description": "network domain", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "networkdomain", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "Force update even if CIDR type is different", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "changecidr", + "name": "displaynetwork", "required": false, "type": "boolean" }, { - "description": "IPV4 address to be assigned to the public interface of the network router. This address must already be acquired for this network", + "description": "the first IPv4 DNS for the network. Empty string will update the first IPv4 DNS with the value from the zone", "length": 255, - "name": "sourcenatipaddress", + "name": "dns1", "required": false, - "since": "4.19", + "since": "4.18.0", "type": "string" - }, - { - "description": "network offering ID", - "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", - "required": false, - "type": "uuid" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "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": "the network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", - "type": "string" - }, - { - "description": "zone id of the network", - "name": "zoneid", - "type": "string" - }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - {}, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, - { - "description": "the details of the network", - "name": "details", - "type": "map" - }, { "description": "The internet protocol of network offering", "name": "internetprotocol", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" - }, - { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" - }, - { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", - "type": "string" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", - "type": "string" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "state of the network", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", "type": "boolean" }, { @@ -33909,54 +34049,13 @@ "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {}, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" - }, - { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "the date this network was created", - "name": "created", - "type": "date" - }, - { - "description": "the type of the network", - "name": "type", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { @@ -33964,18 +34063,18 @@ "name": "tags", "response": [ { - "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 value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -33989,23 +34088,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "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": "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" }, { @@ -34022,58 +34121,108 @@ "type": "list" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 owner of the network", + "name": "account", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, + { + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" + }, { "description": "true if network is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" + }, + { + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { @@ -34082,13 +34231,38 @@ "type": "long" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", "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": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { @@ -34097,13 +34271,13 @@ "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": "the project id of the ipaddress", - "name": "projectid", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { @@ -34116,39 +34290,27 @@ "type": "string" }, { - "description": "the list of capabilities", - "name": "capability", + "description": "the service provider name", + "name": "provider", "response": [ { - "description": "the capability name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" }, { - "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", + "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" }, { @@ -34156,25 +34318,37 @@ "name": "canenableindividualservice", "type": "boolean" }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, { "description": "the provider name", "name": "name", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability value", + "name": "value", + "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the capability name", + "name": "name", "type": "string" }, { - "description": "state of the network provider", - "name": "state", - "type": "string" + "description": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", + "type": "boolean" } ], "type": "list" @@ -34183,18 +34357,18 @@ "type": "list" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "the name of the network", + "name": "name", "type": "string" }, { @@ -34203,114 +34377,166 @@ "type": "boolean" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" + }, + { + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "the id of the network", + "name": "id", + "type": "string" + }, + { + "description": "the domain id of the network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "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": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "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": "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 gateway of IPv6 network", - "name": "ip6gateway", + "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", "type": "string" }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the domain name of the network owner", + "name": "domain", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "list networks that are persistent", + "name": "ispersistent", "type": "boolean" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", - "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 network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" } ] }, @@ -34320,19 +34546,33 @@ "name": "listBackups", "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": "id of the VM", + "description": "", "length": 255, - "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", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "list backups by name", + "length": 255, + "name": "name", + "required": false, + "since": "4.21.0", + "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": "list only resources belonging to the domain specified", @@ -34343,33 +34583,33 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "id of the VM", "length": 255, - "name": "keyword", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list backups by name", + "description": "id of the backup", "length": 255, - "name": "name", + "name": "id", + "related": "updateBackupSchedule,listBackups", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { - "description": "list backups with VM details", + "description": "List by keyword", "length": 255, - "name": "listvmdetails", + "name": "keyword", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "string" }, { - "description": "id of the backup", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "updateBackupSchedule,listBackups", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, @@ -34381,11 +34621,12 @@ "type": "integer" }, { - "description": "", + "description": "list backups with VM details", "length": 255, - "name": "pagesize", + "name": "listvmdetails", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "boolean" }, { "description": "list backups by backup offering", @@ -34403,21 +34644,6 @@ "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": "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 backups by zone id", "length": 255, @@ -34430,111 +34656,106 @@ "related": "updateBackupSchedule", "response": [ { - "description": "description for the backup", - "name": "description", - "type": "string" - }, - { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "domain id", + "name": "domainid", "type": "string" }, - { - "description": "backup size in bytes", - "name": "size", - "type": "long" - }, { "description": "backup type", "name": "type", "type": "string" }, + {}, { - "description": "account name", - "name": "account", + "description": "account id", + "name": "accountid", "type": "string" }, + {}, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", + "description": "backup size in bytes", + "name": "size", "type": "long" }, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" + }, + { + "description": "ID of the VM backup", + "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": "domain id", - "name": "domainid", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "Interval type of the backup", - "name": "intervaltype", + "description": "backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "backup date", - "name": "created", - "type": "date" + "description": "backup offering id", + "name": "backupofferingid", + "type": "string" }, - {}, { - "description": "zone id", - "name": "zoneid", + "description": "account name", + "name": "account", "type": "string" }, { - "description": "ID of the VM backup", - "name": "id", + "description": "description for the backup", + "name": "description", "type": "string" }, { - "description": "backed up volumes", - "name": "volumes", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, - {}, { "description": "Lists the vm specific details for the backup", "name": "vmdetails", "type": "map" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "domain name", - "name": "domain", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "zone name", + "name": "zone", + "type": "string" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "name of the backup", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id", + "name": "zoneid", "type": "string" }, { - "description": "account id", - "name": "accountid", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, { "description": "name of the VM", @@ -34542,19 +34763,29 @@ "type": "string" }, { - "description": "external backup id", - "name": "externalid", + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "name of the backup", - "name": "name", - "type": "string" + "description": "backup status", + "name": "status", + "type": "status" }, { - "description": "zone name", - "name": "zone", + "description": "Interval type of the backup", + "name": "intervaltype", "type": "string" + }, + { + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" + }, + { + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" } ], "since": "4.14.0" @@ -34566,21 +34797,18 @@ "params": [], "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": "Usage type name", "name": "name", "type": "string" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, { "description": "Usage type ID", "name": "id", @@ -34591,8 +34819,11 @@ "name": "description", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -34610,27 +34841,27 @@ ], "related": "", "response": [ - { - "description": "the CA service 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 CA service provider", "name": "description", "type": "string" }, + { + "description": "the CA service provider name", + "name": "name", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, {} ], "since": "4.14.0" @@ -34652,18 +34883,13 @@ "related": "listNsxControllers", "response": [ { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "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 tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", + "name": "tier0gateway", "type": "string" }, { @@ -34672,42 +34898,47 @@ "type": "string" }, { - "description": "NSX controller hostname or IP address", - "name": "hostname", + "description": "NSX controller port", + "name": "port", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {}, { - "description": "NSX controller name", - "name": "name", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { - "description": "NSX controller port", - "name": "port", + "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 name of the edge cluster. An edge cluster is a logical grouping of edge nodes in NSX", - "name": "edgecluster", + "description": "NSX controller hostname or IP address", + "name": "hostname", "type": "string" }, { - "description": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", - "name": "transportzone", + "description": "NSX controller ID", + "name": "nsxprovideruuid", "type": "string" }, { - "description": "Zone name to which the NSX controller is associated with", - "name": "zonename", + "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 tier-0 gateway network. Tier-0 gateway is responsible for handling traffic between logical and physical networks", - "name": "tier0gateway", + "description": "NSX controller name", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.19.0" }, @@ -34717,54 +34948,61 @@ "name": "updateGuiTheme", "params": [ { - "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "length": 65535, - "name": "css", + "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", + "length": 255, + "name": "recursivedomains", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "A set of domain UUIDs (also known as ID for the end-user) separated by comma that can retrieve the theme.", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", "length": 65535, - "name": "domainids", + "name": "jsonconfiguration", "required": false, "type": "string" }, { - "description": "A name to identify the theme.", - "length": 2048, - "name": "name", + "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": "A set of Common Names (CN) (fixed or wildcard) separated by comma that can retrieve the theme; e.g.: *acme.com,acme2.com", + "description": "The ID of the theme to be updated.", + "length": 255, + "name": "id", + "related": "listGuiThemes,updateGuiTheme,createGuiTheme", + "required": true, + "type": "uuid" + }, + { + "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": "commonnames", + "name": "domainids", "required": false, "type": "string" }, { - "description": "Defines whether the subdomains of the informed domains are considered. Default value is false.", - "length": 255, - "name": "recursivedomains", + "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": "boolean" + "type": "string" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", "length": 65535, - "name": "jsonconfiguration", + "name": "css", "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 name to identify the theme.", + "length": 2048, + "name": "name", + "required": false, + "type": "string" }, { "description": "A description for the theme.", @@ -34779,35 +35017,13 @@ "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" } ], "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", + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { @@ -34815,20 +35031,20 @@ "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": "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", + "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" }, { @@ -34837,31 +35053,46 @@ "type": "string" }, { - "description": "Whether to consider the subdomains of the informed domain IDs.", - "name": "recursivedomains", - "type": "boolean" + "description": "ID of the custom GUI theme.", + "name": "id", + "type": "string" }, { - "description": "When the GUI theme was created.", - "name": "created", + "description": "When the GUI theme was removed.", + "name": "removed", "type": "date" }, { - "description": "Name of the GUI theme.", - "name": "name", - "type": "string" + "description": "When the GUI theme was created.", + "name": "created", + "type": "date" }, { "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Name of the GUI theme.", + "name": "name", + "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" }, @@ -34880,9 +35111,11 @@ } ], "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" }, { @@ -34890,18 +35123,16 @@ "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" + } ] }, { @@ -34910,73 +35141,48 @@ "name": "migrateVirtualMachine", "params": [ { - "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", + "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "autoselect", "required": false, - "type": "uuid" + "since": "4.16.0", + "type": "boolean" }, { - "description": "the ID of the virtual machine", + "description": "Destination storage pool ID to migrate VM volumes to. Required for migrating the root disk volume", "length": 255, - "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": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, "type": "uuid" }, { "description": "Destination Host ID to migrate VM to.", "length": 255, "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "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", + "description": "the ID of the virtual machine", "length": 255, - "name": "autoselect", - "required": false, - "since": "4.16.0", - "type": "boolean" + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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": "Name of AutoScale VM group", "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { @@ -34985,130 +35191,43 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "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": "the project id of the vm", - "name": "projectid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "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 domain name of the affinity group", - "name": "domain", - "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": "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 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": "the description of the affinity group", - "name": "description", - "type": "string" - }, - { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "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 project name of the vm", - "name": "project", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { @@ -35117,48 +35236,48 @@ "type": "date" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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": "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -35166,17 +35285,94 @@ "name": "securitygroup", "response": [ { - "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 list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "account owning the security group rule", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the account associated with the tag", "name": "account", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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": "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" + }, + { + "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" + } + ], + "type": "set" + }, + { + "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 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": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -35185,15 +35381,35 @@ "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 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 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 list of resource tags associated with the rule", "name": "tags", @@ -35204,33 +35420,33 @@ "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": "the account associated with the tag", + "name": "account", "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": "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 project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -35239,8 +35455,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -35249,50 +35465,25 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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 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 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" }, { - "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", @@ -35303,14 +35494,29 @@ "name": "icmptype", "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", + "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": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -35318,13 +35524,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -35333,61 +35539,51 @@ "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": "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": "id of the resource", - "name": "resourceid", + "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": "tag key name", - "name": "key", + "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": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "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": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -35396,13 +35592,8 @@ "type": "integer" }, { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], @@ -35413,249 +35604,188 @@ "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", + "description": "the description of the security group", + "name": "description", "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 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 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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "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" - } - ], - "type": "set" - }, { "description": "the project name of the group", "name": "project", "type": "string" + }, + { + "description": "the domain name of the security group", + "name": "domain", + "type": "string" } ], "type": "set" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, + {}, { - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "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 name of the template for the virtual machine", - "name": "templatename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "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 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 list of nics associated with vm", "name": "nic", "response": [ { - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "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 ID of the corresponding network", "name": "networkid", "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", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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": "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 associated with this nic via Static nat rule", + "name": "publicip", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "the name of the corresponding network", @@ -35663,18 +35793,18 @@ "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": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -35682,93 +35812,108 @@ "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", + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the type of the nic", + "name": "type", "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "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": "the maximum X resolution", - "name": "maxresolutionx", - "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" + }, + { + "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", @@ -35776,102 +35921,43 @@ "type": "long" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, - {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "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 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 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 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": "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -35880,224 +35966,369 @@ "type": "boolean" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "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", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "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", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "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": "device type of the root volume", - "name": "rootdevicetype", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "the state of the virtual machine", "name": "state", "type": "string" }, { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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": "CPU arch of the VM", - "name": "arch", + "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 generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ + { + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + }, + { + "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "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 name of the affinity group", + "name": "name", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "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": "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": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "Guest vm Boot Type", + "name": "boottype", "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 type of the template for the virtual machine", - "name": "templatetype", + "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 user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, { "description": "device ID of the root volume", "name": "rootdeviceid", "type": "long" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "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 service offering of the virtual machine", - "name": "serviceofferingid", + "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 id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the name of the virtual machine", + "name": "name", "type": "string" } ] @@ -36117,28 +36348,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": "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" }, @@ -36151,34 +36382,34 @@ "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "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": "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" - } + {} ] }, { @@ -36186,13 +36417,6 @@ "isasync": false, "name": "listBaremetalRct", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -36206,31 +36430,38 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "addBaremetalRct", "response": [ - { - "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": "url", "name": "url", "type": "string" }, {}, - {}, + { + "description": "id of rct", + "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" } ] }, @@ -36250,26 +36481,26 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the CA service provider name", + "name": "name", "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", - "name": "name", + "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.11.0" @@ -36289,27 +36520,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": "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" + }, {} ] }, @@ -36318,22 +36549,6 @@ "isasync": false, "name": "listPortForwardingRules", "params": [ - { - "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 ID of IP address of the port forwarding services", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -36342,35 +36557,34 @@ "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": "List resources by tags (key/value pairs)", + "description": "list port forwarding rules for certain network", "length": 255, - "name": "tags", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "map" + "since": "4.3", + "type": "uuid" }, { - "description": "Lists rule with the specified 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": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list port forwarding rules for certain network", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "since": "4.3", - "type": "uuid" + "type": "string" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -36389,18 +36603,35 @@ "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": "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": "Lists rule with the specified ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,listPortForwardingRules,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the ID of IP address of the port forwarding services", + "length": 255, + "name": "ipaddressid", + "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" + }, + { + "description": "List resources by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { "description": "", @@ -36410,104 +36641,37 @@ "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" } ], - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "response": [ - { - "description": "the VM name for the port forwarding rule", - "name": "virtualmachinename", - "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 VM ID for the port forwarding rule", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", - "type": "string" - }, - {}, - { - "description": "the VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", - "type": "string" - }, - { - "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", - "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 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": "the account associated with the tag", + "name": "account", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -36516,8 +36680,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -36526,13 +36690,8 @@ "type": "string" }, { - "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" }, { @@ -36541,22 +36700,27 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "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 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", @@ -36564,14 +36728,81 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "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", "name": "jobstatus", "type": "integer" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "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 protocol of the port forwarding rule", + "name": "protocol", + "type": "string" + }, + {}, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", + "type": "string" + }, + { + "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" } ] }, @@ -36600,16 +36831,26 @@ "related": "", "response": [ { - "description": "the ID of the pod the IP address belongs to", - "name": "podid", - "type": "long" + "description": "Gateway for Pod ", + "name": "gateway", + "type": "string" }, - {}, { "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 ID of the pod the IP address belongs to", + "name": "podid", + "type": "long" + }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -36620,31 +36861,21 @@ "name": "cidr", "type": "string" }, - { - "description": "the ID of the nic", - "name": "nicid", - "type": "long" - }, { "description": "Allocated IP address", "name": "ipaddress", "type": "string" }, + { + "description": "the ID of the nic", + "name": "nicid", + "type": "long" + }, {}, { "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" } ] }, @@ -36665,17 +36896,36 @@ "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ { - "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": "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 username", + "name": "username", + "type": "string" + }, { "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": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -36687,23 +36937,19 @@ "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 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 out-of-band management action (if issued)", - "name": "action", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, { @@ -36715,21 +36961,6 @@ "description": "the out-of-band management interface address", "name": "address", "type": "string" - }, - { - "description": "the ID of the host", - "name": "hostid", - "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", - "name": "password", - "type": "string" } ], "since": "4.9.0" @@ -36740,12 +36971,12 @@ "name": "updateTemplatePermissions", "params": [ { - "description": "the template ID", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "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" + "name": "projectids", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "list" }, { "description": "permission operator (add, remove, reset)", @@ -36755,16 +36986,17 @@ "type": "string" }, { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "the template ID", "length": 255, - "name": "accounts", - "required": false, - "type": "list" + "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" }, { - "description": "true for public template/iso, false for private templates/isos", + "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", "length": 255, - "name": "ispublic", + "name": "isextractable", "required": false, "type": "boolean" }, @@ -36776,37 +37008,36 @@ "type": "boolean" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "projectids", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "accounts", "required": false, "type": "list" }, { - "description": "true if the template/iso is extractable, false other wise. Can be set only by root admin", + "description": "true for public template/iso, false for private templates/isos", "length": 255, - "name": "isextractable", + "name": "ispublic", "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", + "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" }, {}, { @@ -36833,61 +37064,106 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 pool type of the virtual machine", - "name": "pooltype", + "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": "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 date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, { "description": "public IP address id associated with vm via Static nat rule", "name": "publicipid", "type": "string" }, + { + "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", "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "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 control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -36895,166 +37171,175 @@ "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": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "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 group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, + {}, { - "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 account associated with the virtual machine", - "name": "account", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "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": "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", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", + "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 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", + "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", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "IP addresses associated with NIC found for unmanaged VM", @@ -37062,28 +37347,8 @@ "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -37092,18 +37357,13 @@ "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", - "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 ID of the corresponding network", - "name": "networkid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -37112,43 +37372,33 @@ "type": "list" }, { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { @@ -37157,481 +37407,151 @@ "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", + "description": "Type of adapter if available", + "name": "adaptertype", "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 ID of the nic", - "name": "id", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", "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 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": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "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": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "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 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", + "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 disk read in KiB", - "name": "diskkbsread", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the maximum number of display heads", + "name": "maxheads", "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "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" - }, - { - "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": "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", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "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", + "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": "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 maximum X resolution", + "name": "maxresolutionx", + "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - {}, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -37639,14 +37559,29 @@ "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the description of the security group", + "name": "description", "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": "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", + "type": "integer" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", @@ -37662,86 +37597,66 @@ "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": "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 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 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": "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": "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": "resource type", + "name": "resourcetype", "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 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", - "name": "startport", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", + "description": "security group name", + "name": "securitygroupname", "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" }, { @@ -37750,18 +37665,33 @@ "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 id of the security group rule", + "name": "ruleid", + "type": "string" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "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 virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, { "description": "the account owning the security group", "name": "account", @@ -37773,228 +37703,529 @@ "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", + "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 ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "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": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "account owning the security group rule", + "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" - } - ], - "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 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 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 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 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 account associated with the tag", - "name": "account", + "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": "the project name where tag belongs to", - "name": "project", + "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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "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": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "id of the resource", + "name": "resourceid", "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": "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": "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "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": "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": "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 key name", + "name": "key", "type": "string" } ], "type": "set" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" } ], "type": "set" }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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 vm", + "name": "projectid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + {}, + {}, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "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 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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "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", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "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", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "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": "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 name of the gpu card to which service offering is linked", + "name": "gpucardname", + "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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "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 description of the affinity group", + "name": "description", + "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 project ID of the affinity group", + "name": "projectid", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" } ] }, @@ -38013,27 +38244,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": "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.21.0" @@ -38043,14 +38274,6 @@ "isasync": false, "name": "listBrocadeVcsDevices", "params": [ - { - "description": "Brocade VCS switch ID", - "length": 255, - "name": "vcsdeviceid", - "related": "listBrocadeVcsDevices", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -38059,11 +38282,12 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "Brocade VCS switch ID", "length": 255, - "name": "keyword", + "name": "vcsdeviceid", + "related": "listBrocadeVcsDevices", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -38079,27 +38303,28 @@ "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", "required": false, "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "", "response": [ + {}, { - "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": "device id of the Brocade Vcs", "name": "vcsdeviceid", "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", "name": "physicalnetworkid", @@ -38110,16 +38335,22 @@ "name": "provider", "type": "string" }, + { + "description": "device name", + "name": "brocadedevicename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "device name", - "name": "brocadedevicename", + "description": "the principal switch Ip address", + "name": "hostname", "type": "string" - } + }, + {} ] }, { @@ -38127,6 +38358,13 @@ "isasync": false, "name": "linkDomainToLdap", "params": [ + { + "description": "name of the group or OU in LDAP", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "type of the ldap name. GROUP or OU", "length": 255, @@ -38134,6 +38372,13 @@ "required": true, "type": "string" }, + { + "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", + "length": 255, + "name": "accounttype", + "required": true, + "type": "integer" + }, { "description": "The id of the domain which has to be linked to LDAP.", "length": 255, @@ -38149,70 +38394,56 @@ "required": false, "type": "string" }, - { - "description": "Type of the account to auto import. Specify 0 for user and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": true, - "type": "integer" - }, { "description": "name of the group or OU in LDAP", "length": 255, "name": "ldapdomain", "required": false, "type": "string" - }, - { - "description": "name of the group or OU in LDAP", - "length": 255, - "name": "name", - "required": false, - "type": "string" } ], "related": "linkAccountToLdap", "response": [ - {}, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "name of the group or OU in LDAP which is linked to the domain", + "name": "ldapdomain", "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", + "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", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "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" }, { - "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" }, { - "description": "id of the Domain which is linked to LDAP", - "name": "domainid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "Domain Admin accountId that is created", + "name": "accountid", "type": "string" } ], @@ -38223,6 +38454,13 @@ "isasync": false, "name": "cancelMaintenance", "params": [ + { + "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" + }, { "description": "the id of the management server", "length": 255, @@ -38230,69 +38468,62 @@ "related": "listManagementServers", "required": true, "type": "uuid" - }, - { - "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": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "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": "Indicates whether a shutdown has been triggered", "name": "shutdowntriggered", "type": "boolean" }, { - "description": "The id of the management server", - "name": "managementserverid", - "type": "string" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "Indicates whether maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" }, + {}, { "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" + "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" + } ], "since": "4.21.0" }, @@ -38308,13 +38539,6 @@ "required": false, "type": "string" }, - { - "description": "Enabled by default, provide false to disable 2FA", - "length": 255, - "name": "enable", - "required": false, - "type": "boolean" - }, { "description": "optional: the id of the user for which 2FA has to be disabled", "length": 255, @@ -38322,17 +38546,23 @@ "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" + }, + { + "description": "Enabled by default, provide false to disable 2FA", + "length": 255, + "name": "enable", + "required": false, + "type": "boolean" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", @@ -38344,13 +38574,14 @@ "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user ID", + "name": "id", "type": "string" }, + {}, { - "description": "the user ID", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -38366,20 +38597,6 @@ "isasync": false, "name": "listVpnCustomerGateways", "params": [ - { - "description": "list resources by account. 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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -38388,11 +38605,12 @@ "type": "boolean" }, { - "description": "", + "description": "id of the customer gateway", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -38403,11 +38621,18 @@ "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": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -38418,71 +38643,68 @@ "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 by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "id of the customer gateway", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "id", - "related": "createVpnCustomerGateway,listVpnCustomerGateways,updateVpnCustomerGateway", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "response": [ { - "description": "the domain name of the owner", - "name": "domain", - "type": "string" - }, - { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" - }, - { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", + "description": "the owner", + "name": "account", "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": "the project name", + "name": "project", + "type": "string" }, { "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "public ip address id of the customer gateway", - "name": "gateway", + "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", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", + "type": "long" + }, + { + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -38491,18 +38713,13 @@ "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "the project name", - "name": "project", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { @@ -38511,47 +38728,61 @@ "type": "string" }, { - "description": "the project id", - "name": "projectid", + "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": "IKE policy of customer gateway", + "name": "ikepolicy", + "type": "string" }, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", - "type": "string" + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, {}, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", "type": "long" }, + { + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" + }, + { + "description": "name of the customer gateway", + "name": "name", + "type": "string" + }, { "description": "IPsec preshared-key of customer gateway", "name": "ipsecpsk", @@ -38565,12 +38796,12 @@ "name": "deleteKubernetesCluster", "params": [ { - "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" }, { "description": "Expunge attached instances of the ExternalManaged Cluster. If true, value of cleanup is ignored. Default: false", @@ -38581,15 +38812,21 @@ "type": "boolean" }, { - "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" } ], "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", @@ -38597,19 +38834,13 @@ "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": "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" } ] @@ -38619,6 +38850,13 @@ "isasync": false, "name": "listWebhooks", "params": [ + { + "description": "The scope of the Webhook", + "length": 255, + "name": "scope", + "required": false, + "type": "string" + }, { "description": "The ID of the Webhook", "length": 255, @@ -38627,6 +38865,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "The state of the Webhook", "length": 255, @@ -38643,18 +38888,11 @@ "type": "uuid" }, { - "description": "The name of the Webhook", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -38664,11 +38902,11 @@ "type": "string" }, { - "description": "The scope of the Webhook", + "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": "scope", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -38678,18 +38916,19 @@ "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 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": "", + "description": "The name of the Webhook", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -38697,47 +38936,23 @@ "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 state of the Webhook", - "name": "state", - "type": "string" - }, - { - "description": "The name of the domain in which the Webhook exists", - "name": "domain", + "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 ID of the domain in which the Webhook exists", "name": "domainid", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", - "type": "string" - }, - {}, - { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, { @@ -38746,33 +38961,39 @@ "type": "date" }, { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" + "description": "The scope of the Webhook", + "name": "scope", + "type": "string" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", + "type": "string" + }, + { + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, + {}, { "description": "The account associated with the Webhook", "name": "account", "type": "string" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", - "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", + "description": "The name of the Webhook", + "name": "name", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { @@ -38780,49 +39001,106 @@ "name": "secretkey", "type": "string" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "The state of the Webhook", + "name": "state", + "type": "string" + }, + {}, + { + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "The name of the Webhook", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "User uuid", + "length": 255, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, + "type": "uuid" + }, + { + "description": "Domain uuid", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "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": "Creates a global load balancer rule", "isasync": true, "name": "createGlobalLoadBalancerRule", "params": [ { - "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", - "length": 255, - "name": "account", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, { - "description": "GSLB service type (tcp, udp, http)", + "description": "domain name for the GSLB service.", "length": 255, - "name": "gslbservicetype", + "name": "gslbdomainname", "required": true, "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "description": "name of the load balancer rule", "length": 255, - "name": "gslbstickysessionmethodname", - "required": false, + "name": "name", + "required": true, "type": "string" }, { @@ -38832,6 +39110,14 @@ "required": false, "type": "string" }, + { + "description": "region where the global load balancer is going to be created.", + "length": 255, + "name": "regionid", + "related": "addRegion,updateRegion,listRegions", + "required": true, + "type": "integer" + }, { "description": "the domain ID associated with the load balancer", "length": 255, @@ -38841,31 +39127,23 @@ "type": "uuid" }, { - "description": "region where the global load balancer is going to be created.", + "description": "session sticky method (sourceip) if not specified defaults to sourceip", "length": 255, - "name": "regionid", - "related": "addRegion,updateRegion,listRegions", - "required": true, - "type": "integer" - }, - { - "description": "the description of the load balancer rule", - "length": 4096, - "name": "description", + "name": "gslbstickysessionmethodname", "required": false, "type": "string" }, { - "description": "domain name for the GSLB service.", + "description": "the account associated with the global load balancer. Must be used with the domainId parameter.", "length": 255, - "name": "gslbdomainname", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "name of the load balancer rule", + "description": "GSLB service type (tcp, udp, http)", "length": 255, - "name": "name", + "name": "gslbservicetype", "required": true, "type": "string" } @@ -38873,23 +39151,38 @@ "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "response": [ { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the project id of the load balancer", - "name": "projectid", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" + }, + { + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the description of the global load balancer rule", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, { @@ -38897,13 +39190,33 @@ "name": "loadbalancerrule", "response": [ { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", + "description": "the public ip address id", + "name": "publicipid", + "type": "string" + }, + { + "description": "the project name of the load balancer", + "name": "project", + "type": "string" + }, + { + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the description of the load balancer", + "name": "description", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -38911,91 +39224,96 @@ "name": "algorithm", "type": "string" }, + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, { "description": "the list of resource tags associated with load balancer", "name": "tags", "response": [ { - "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": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "the project id the tag belongs to", - "name": "projectid", + "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": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "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 protocol of the loadbalanacer rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the public port", + "name": "publicport", "type": "string" }, { @@ -39004,18 +39322,18 @@ "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 public ip address", + "name": "publicip", "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the name of the load balancer", + "name": "name", "type": "string" }, { @@ -39024,61 +39342,26 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" - }, - { - "description": "the public port", - "name": "publicport", - "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 description of the load balancer", - "name": "description", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { "description": "the id of the zone the rule belongs to", "name": "zoneid", "type": "string" - }, - { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" - }, - { - "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" } ], "type": "list" }, { - "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", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -39087,28 +39370,24 @@ "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", + "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", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", "type": "string" }, {}, @@ -39118,16 +39397,15 @@ "type": "integer" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the project id of the load balancer", + "name": "projectid", "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" - }, - {} + } ] }, { @@ -39145,12 +39423,18 @@ } ], "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", @@ -39160,12 +39444,6 @@ "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" } ] }, @@ -39182,11 +39460,12 @@ "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 customer name", @@ -39196,18 +39475,19 @@ "type": "string" }, { - "description": "list by resource type", + "description": "list by resource id", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": false, "type": "string" }, { - "description": "list by key", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "key", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list by value", @@ -39217,53 +39497,51 @@ "type": "string" }, { - "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": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list by resource id", + "description": "list by key", "length": 255, - "name": "resourceid", + "name": "key", "required": false, "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": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "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 resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "List by keyword", + "description": "list by resource type", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, "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" } @@ -39271,13 +39549,13 @@ "related": "listResourceDetails", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -39286,57 +39564,57 @@ "type": "integer" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "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": "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": "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, - {}, { - "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": "tag key name", "name": "key", "type": "string" - } + }, + {} ], "since": "4.0.0" }, @@ -39345,6 +39623,13 @@ "isasync": false, "name": "listAffectedVmsForStorageScopeChange", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the Id of the storage pool on which change scope operation is being done", "length": 255, @@ -39360,20 +39645,6 @@ "required": false, "type": "integer" }, - { - "description": "", - "length": 255, - "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, @@ -39381,23 +39652,27 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - { - "description": "the cluster name for the VM", - "name": "clustername", - "type": "string" - }, + {}, + {}, { "description": "the name of the VM", "name": "name", "type": "string" }, { - "description": "the type of VM", - "name": "type", + "description": "the hostname for the VM", + "name": "hostname", "type": "string" }, { @@ -39406,32 +39681,35 @@ "type": "string" }, { - "description": "the hostname for the VM", - "name": "hostname", + "description": "the host ID for the VM", + "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 VM", "name": "id", "type": "string" }, { - "description": "the host ID for the VM", - "name": "hostid", + "description": "the cluster ID for the VM", + "name": "clusterid", "type": "string" }, { - "description": "the cluster ID for the VM", - "name": "clusterid", + "description": "the type of VM", + "name": "type", "type": "string" }, - {} + { + "description": "the cluster name for the VM", + "name": "clustername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.19.1" }, @@ -39441,33 +39719,27 @@ "name": "createVirtualRouterElement", "params": [ { - "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" }, { - "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" } ], "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", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { @@ -39480,6 +39752,16 @@ "name": "nspid", "type": "string" }, + { + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" + }, {}, { "description": "the account associated with the provider", @@ -39487,8 +39769,8 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { @@ -39501,19 +39783,15 @@ "name": "jobid", "type": "string" }, - { - "description": "the domain ID associated with the provider", - "name": "domainid", - "type": "string" - }, { "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" } ] @@ -39524,28 +39802,27 @@ "name": "createVPC", "params": [ { - "description": "the ID of the availability zone", + "description": "the second IPv4 DNS for the VPC", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "dns2", + "required": false, + "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": "VPC network domain. All networks inside the VPC will belong to this domain", "length": 255, - "name": "sourcenatipaddress", + "name": "networkdomain", "required": false, - "since": "4.19", "type": "string" }, { - "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 first IPv6 DNS for the VPC", @@ -39556,17 +39833,17 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "dns2", + "name": "publicmtu", "required": false, "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "The display text of the VPC, defaults to its 'name'.", "length": 255, - "name": "cidr", + "name": "displaytext", "required": false, "type": "string" }, @@ -39578,13 +39855,6 @@ "since": "4.20.0", "type": "long" }, - { - "description": "The display text of the VPC, defaults to its 'name'.", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, { "description": "create VPC for the project", "length": 255, @@ -39594,20 +39864,28 @@ "type": "uuid" }, { - "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", + "description": "the cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "userouteripresolver", + "name": "cidr", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the VPC offering", + "description": "the ID of the availability zone", "length": 255, - "name": "vpcofferingid", - "related": "updateVPCOffering,listVPCOfferings", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": true, "type": "uuid" }, + { + "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, { "description": "the name of the VPC", "length": 255, @@ -39616,60 +39894,59 @@ "type": "string" }, { - "description": "the domain ID associated with the VPC. If used with the account parameter returns the VPC associated with the account for the specified domain.", + "description": "Ids of the Bgp Peer for the VPC", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "bgppeerids", + "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", "required": false, - "type": "uuid" + "since": "4.20.0", + "type": "list" }, { - "description": "the first 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": "dns1", + "name": "sourcenatipaddress", "required": false, - "since": "4.18.0", + "since": "4.19", "type": "string" }, { - "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, - "type": "string" + "name": "vpcofferingid", + "related": "updateVPCOffering,listVPCOfferings", + "required": true, + "type": "uuid" }, { - "description": "the second IPv6 DNS for the VPC", + "description": "the account associated with the VPC. Must be used with the domainId parameter.", "length": 255, - "name": "ip6dns2", + "name": "account", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "the first IPv4 DNS for the VPC", "length": 255, - "name": "publicmtu", + "name": "dns1", "required": false, "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "Ids of the Bgp Peer for the VPC", + "description": "(optional) for NSX based VPCs: when set to true, use the VR IP as nameserver, otherwise use DNS1 and DNS2", "length": 255, - "name": "bgppeerids", - "related": "createBgpPeer,listBgpPeers,updateBgpPeer,dedicateBgpPeer,releaseBgpPeer", + "name": "userouteripresolver", "required": false, - "since": "4.20.0", - "type": "list" + "type": "boolean" }, { - "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 second IPv6 DNS for the VPC", "length": 255, - "name": "start", + "name": "ip6dns2", "required": false, - "since": "4.3", - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { "description": "an optional field, whether to the display the vpc to the end user or not", @@ -39680,78 +39957,33 @@ "type": "boolean" }, { - "description": "the account associated with the VPC. Must be used with the domainId parameter.", + "description": "the CIDR size of VPC. For regular users, this is required for VPC with ROUTED mode.", "length": 255, - "name": "account", + "name": "cidrsize", "required": false, - "type": "string" + "since": "4.20.0", + "type": "integer" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "response": [ { - "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 list of networks belongign to the VPC", - "name": "network", - "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 id of the VPC", - "name": "id", - "type": "string" - }, - { - "description": "the name of the VPC", - "name": "name", - "type": "string" - }, - { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "type": "string" - }, - { - "description": "an alternate display text of the VPC.", - "name": "displaytext", - "type": "string" - }, - { - "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": "the list of resource tags associated with the project", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" }, { @@ -39765,13 +39997,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "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" }, { @@ -39780,87 +40007,133 @@ "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 domain associated with the tag", + "name": "domain", "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", - "type": "boolean" + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", + "type": "string" }, { - "description": "zone id of the vpc", - "name": "zoneid", + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "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", - "name": "account", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the cidr the VPC", + "name": "cidr", "type": "string" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", - "type": "boolean" + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" }, { "description": "the second IPv6 DNS for the VPC", "name": "ip6dns2", "type": "string" }, + {}, + { + "description": "zone id of the vpc", + "name": "zoneid", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "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": "if this VPC has redundant router", "name": "redundantvpcrouter", "type": "boolean" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "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 list of networks belongign to the VPC", + "name": "network", + "type": "list" }, { "description": "The routes for the network to ease adding route in upstream router", @@ -39868,50 +40141,49 @@ "type": "set" }, { - "description": "the cidr the VPC", - "name": "cidr", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "description": "The routes for the VPC to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "the project name of the VPC", + "name": "project", + "type": "string" }, - {}, { - "description": "the name of the zone the VPC belongs to", - "name": "zonename", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "the date this VPC was created", - "name": "created", - "type": "date" + "description": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "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 list of supported services", @@ -39926,31 +40198,31 @@ "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" + }, + { + "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" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "uuid of the network provider", - "name": "id", + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", "type": "string" }, { @@ -39959,13 +40231,13 @@ "type": "boolean" }, { - "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": "uuid of the network provider", + "name": "id", "type": "string" }, { @@ -39974,49 +40246,55 @@ "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" + }, + { + "description": "the service name", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "true VPC requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" }, { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "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": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "an alternate display text of the VPC.", + "name": "displaytext", + "type": "string" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "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 project id of the VPC", - "name": "projectid", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" } ] @@ -40027,9 +40305,9 @@ "name": "removeResourceDetail", "params": [ { - "description": "Delete detail by resource type", + "description": "Delete details for resource id", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": true, "type": "string" }, @@ -40041,9 +40319,9 @@ "type": "string" }, { - "description": "Delete details for resource id", + "description": "Delete detail by resource type", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": true, "type": "string" } @@ -40054,6 +40332,12 @@ "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", @@ -40064,12 +40348,6 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {}, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" } ] }, @@ -40081,70 +40359,59 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by Os type Id", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "listOsTypes,addGuestOs", "required": false, - "since": "4.18.1", - "type": "boolean" + "type": "uuid" }, { - "description": "list os by description", + "description": "List by keyword", "length": 255, - "name": "description", + "name": "keyword", "required": false, - "since": "3.0.1", "type": "string" }, { - "description": "List by keyword", + "description": "list by Os Category id", "length": 255, - "name": "keyword", + "name": "oscategoryid", + "related": "listOsCategories,addOsCategory", "required": false, - "type": "string" + "type": "uuid" }, { - "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.18.1", + "type": "boolean" }, { - "description": "list by Os Category id", + "description": "", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories,addOsCategory", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list by Os type Id", + "description": "list os by description", "length": 255, - "name": "id", - "related": "listOsTypes,addGuestOs", + "name": "description", "required": false, - "type": "uuid" + "since": "3.0.1", + "type": "string" } ], "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", @@ -40152,35 +40419,46 @@ }, {}, { - "description": "the name/description of the OS type", - "name": "description", - "type": "string" + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" }, { "description": "the ID of the OS category", "name": "oscategoryid", "type": "string" }, + { + "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 type", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the name/description of the OS type", + "name": "description", + "type": "string" + }, + { + "description": "the name of the OS type", + "name": "name", + "type": "string" + }, + {} ] }, { @@ -40188,13 +40466,6 @@ "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, @@ -40203,6 +40474,13 @@ "required": true, "type": "uuid" }, + { + "description": "the vendor name of the GPU card", + "length": 255, + "name": "vendorname", + "required": false, + "type": "string" + }, { "description": "the display name of the GPU card", "length": 255, @@ -40221,8 +40499,13 @@ "related": "listGpuCards", "response": [ { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" + }, + { + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { @@ -40231,13 +40514,14 @@ "type": "string" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, + {}, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -40245,12 +40529,6 @@ "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", @@ -40281,27 +40559,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 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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.4.0" }, @@ -40322,96 +40600,284 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "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 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": "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 project id the tag belongs to", + "name": "projectid", + "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": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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", + "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { "description": "Vm details in key/value pairs.", "name": "details", "type": "map" }, + {}, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { "description": "List of read-only Vm details as comma separated string.", "name": "readonlydetails", "type": "string" }, + { + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, { "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": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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 speed of each vCPU", + "name": "cpuspeed", + "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" }, { @@ -40420,25 +40886,44 @@ "type": "string" }, { - "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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 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 availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { "description": "Name of AutoScale VM group", @@ -40446,33 +40931,83 @@ "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -40481,61 +41016,149 @@ "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", "response": [ { - "description": "the domain ID of the security group", + "description": "the name of the affinity group", + "name": "name", + "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 ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "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 domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the domain name of the security group", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "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 internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "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 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 ID of the security group", + "name": "id", + "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 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": "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", + "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" }, { @@ -40543,38 +41166,28 @@ "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", - "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": "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -40587,11 +41200,6 @@ "name": "customer", "type": "string" }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -40603,113 +41211,153 @@ "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": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "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 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 CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" } ], "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 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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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 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": "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 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": "tag value", + "name": "value", "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "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", - "type": "string" - }, { "description": "the list of ingress rules associated with the security group", "name": "ingressrule", @@ -40719,11 +41367,6 @@ "name": "protocol", "type": "string" }, - { - "description": "the code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, { "description": "account owning the security group rule", "name": "account", @@ -40734,24 +41377,14 @@ "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": "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" }, { @@ -40759,8 +41392,13 @@ "name": "tags", "response": [ { - "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", "type": "string" }, { @@ -40773,6 +41411,11 @@ "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", @@ -40784,18 +41427,13 @@ "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" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -40804,362 +41442,192 @@ "type": "string" }, { - "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" } ], "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 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": "path of the Domain the security group belongs to", - "name": "domainpath", - "type": "string" } ], "type": "set" }, { - "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 vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "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", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, + {}, { "description": "the name of the host for the virtual machine", "name": "hostname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "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": "the name of the virtual machine", - "name": "name", - "type": "string" - }, - {}, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "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": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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 name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "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": "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", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ - { - "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": "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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 ID of the corresponding network", - "name": "networkid", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "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 name of the corresponding network", - "name": "networkname", + "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": "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": "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", + "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": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -41172,140 +41640,87 @@ "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", + "description": "the gateway of the nic", + "name": "gateway", "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the domain name of the affinity group", - "name": "domain", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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": "Type of adapter if available", + "name": "adaptertype", "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "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": "publicip", "type": "string" }, { @@ -41314,64 +41729,14 @@ "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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 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 ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", - "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", @@ -41379,111 +41744,24 @@ "type": "string" }, { - "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": "State of the Service from LB rule", - "name": "servicestate", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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": "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "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": "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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": "id of the resource", - "name": "resourceid", - "type": "string" - } - ], - "type": "set" - }, - { - "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" } ] }, @@ -41500,33 +41778,25 @@ "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].vendor=xxx&&details[0].version=2.0", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", "length": 255, - "name": "details", + "name": "timeout", "required": false, - "type": "map" + "type": "integer" }, { - "description": "The description of the command", + "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": "description", + "name": "successmessage", "required": false, "type": "string" }, { - "description": "ID of the custom action", - "length": 255, - "name": "id", - "related": "addCustomAction,listCustomActions", - "required": true, - "type": "uuid" - }, - { - "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", + "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": "successmessage", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { "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)", @@ -41536,70 +41806,78 @@ "type": "boolean" }, { - "description": "List of role types allowed for the action", + "description": "The description of the command", "length": 255, - "name": "allowedroletypes", + "name": "description", "required": false, - "type": "list" + "type": "string" }, { - "description": "Whether the action is enabled or not", + "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": "enabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "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", + "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": "errormessage", + "name": "parameters", "required": false, - "type": "string" + "type": "map" }, { - "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)", + "description": "ID of the custom action", "length": 255, - "name": "cleanupdetails", + "name": "id", + "related": "addCustomAction,listCustomActions", + "required": true, + "type": "uuid" + }, + { + "description": "List of role types allowed for the action", + "length": 255, + "name": "allowedroletypes", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 3 seconds", + "description": "Whether the action is enabled or not", "length": 255, - "name": "timeout", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { - "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", + "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": "parameters", + "name": "errormessage", "required": false, - "type": "map" + "type": "string" } ], "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" } ], "since": "4.21.0" @@ -41619,18 +41897,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": "true if operation is executed successfully", "name": "success", @@ -41640,6 +41906,18 @@ "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" } ] }, @@ -41656,19 +41934,19 @@ "type": "string" }, { - "description": "The ID of the Webhook", + "description": "Payload URL of the Webhook delivery", "length": 255, - "name": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "payloadurl", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Secret key of the Webhook delivery", + "description": "The ID of the Webhook delivery for redelivery", "length": 255, - "name": "secretkey", + "name": "id", + "related": "executeWebhookDelivery", "required": false, - "type": "string" + "type": "uuid" }, { "description": "If set to true then SSL verification will be done for the Webhook delivery otherwise not", @@ -41678,17 +41956,17 @@ "type": "boolean" }, { - "description": "Payload URL of the Webhook delivery", + "description": "Secret key of the Webhook delivery", "length": 255, - "name": "payloadurl", + "name": "secretkey", "required": false, "type": "string" }, { - "description": "The ID of the Webhook delivery for redelivery", + "description": "The ID of the Webhook", "length": 255, - "name": "id", - "related": "executeWebhookDelivery", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, "type": "uuid" } @@ -41696,59 +41974,60 @@ "related": "", "response": [ { - "description": "The ID of the event", - "name": "eventid", + "description": "The ID of the management server which executed delivery", + "name": "managementserverid", "type": "string" }, { - "description": "The name of the Webhook", - "name": "webhookname", + "description": "The type of the event", + "name": "eventtype", "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 payload of the webhook delivery", - "name": "payload", + "description": "The ID of the Webhook delivery", + "name": "id", "type": "string" }, - { - "description": "The start time of the Webhook delivery", - "name": "startdate", - "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": "The end time of the Webhook delivery", "name": "enddate", "type": "date" }, { - "description": "The ID of the Webhook delivery", - "name": "id", + "description": "Whether Webhook delivery succeeded or not", + "name": "success", + "type": "boolean" + }, + {}, + { + "description": "The ID of the event", + "name": "eventid", "type": "string" }, { - "description": "The type of the event", - "name": "eventtype", + "description": "The name of the Webhook", + "name": "webhookname", "type": "string" }, { - "description": "The ID of the Webhook", - "name": "webhookid", + "description": "The payload of the webhook delivery", + "name": "payload", + "type": "string" + }, + { + "description": "The name of the management server which executed delivery", + "name": "managementservername", "type": "string" }, { @@ -41756,10 +42035,9 @@ "name": "headers", "type": "string" }, - {}, { - "description": "The ID of the management server which executed delivery", - "name": "managementserverid", + "description": "The ID of the Webhook", + "name": "webhookid", "type": "string" }, { @@ -41768,9 +42046,9 @@ "type": "string" }, { - "description": "The name of the management server which executed delivery", - "name": "managementservername", - "type": "string" + "description": "The start time of the Webhook delivery", + "name": "startdate", + "type": "date" } ], "since": "4.20.0" @@ -41795,23 +42073,23 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -41822,10 +42100,9 @@ { "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -41837,9 +42114,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -41851,36 +42129,41 @@ ], "related": "createTungstenFabricProvider", "response": [ + { + "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 zone id", + "name": "zoneid", + "type": "long" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", + "type": "string" }, { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider port", + "name": "tungstenproviderport", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric provider introspect port", + "name": "tungstenproviderintrospectport", "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", - "name": "tungstenprovidervrouterport", + "description": "Tungsten-Fabric provider gateway", + "name": "tungstengateway", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider introspect port", - "name": "tungstenproviderintrospectport", + "description": "Tungsten-Fabric provider vrouter port", + "name": "tungstenprovidervrouterport", "type": "string" }, { @@ -41889,29 +42172,24 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" } ] }, @@ -41921,11 +42199,11 @@ "name": "listDeploymentPlanners", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -41935,31 +42213,31 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Deployment Planner name", "name": "name", "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" } ] }, @@ -41978,12 +42256,10 @@ } ], "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", @@ -41991,15 +42267,17 @@ "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" - } + }, + {}, + {} ] }, { @@ -42011,134 +42289,146 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,prepareHostForMaintenance,reconnectHost", "required": true, "type": "uuid" } ], - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "the admin that annotated this host", + "name": "username", "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 implicit host tags for the host", - "name": "implicithosttags", - "type": "string" + "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": "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 total disk size of the host", + "name": "disksizetotal", "type": "long" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "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 after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "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 cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, + {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "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 hypervisor version", - "name": "hypervisorversion", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, { "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", - "type": "long" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -42152,8 +42442,8 @@ "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" }, { @@ -42162,133 +42452,100 @@ "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", + "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 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", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, - {}, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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", + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "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 Pod name of the host", - "name": "podname", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "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": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, - { - "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 in bytes", "name": "memoryallocatedbytes", "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { "description": "the outgoing network traffic on the host", @@ -42296,14 +42553,9 @@ "type": "long" }, { - "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", - "type": "boolean" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { "description": "the resource state of the host", @@ -42311,154 +42563,180 @@ "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", - "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 memory currently used", - "name": "memoryused", - "type": "long" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, + {}, { - "description": "the name of the host", - "name": "name", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "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 OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "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 in percentage", - "name": "cpuallocatedpercentage", + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "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 OS category ID of the host", - "name": "oscategoryid", - "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": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "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": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "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", + "description": "the CPU speed of the host", + "name": "cpuspeed", "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 date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" }, { "description": "the host HA information information", "name": "hostha", "type": "hostharesponse" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" } ] }, @@ -42482,16 +42760,16 @@ "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" + }, {}, { "description": "any text associated with the success or failure", @@ -42515,23 +42793,23 @@ ], "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": "Volume iSCSI Name", "name": "volumeiScsiName", "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" + }, + {} ] }, { @@ -42540,42 +42818,42 @@ "name": "updateAutoScaleVmGroup", "params": [ { - "description": "the name of the autoscale vmgroup", + "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": "name", + "name": "maxmembers", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "an optional field, whether to the display the group to the end user or not", + "description": "the ID of the autoscale group", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", + "required": true, + "type": "uuid" }, { - "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 frequency in which the performance counters to be collected", "length": 255, - "name": "minmembers", + "name": "interval", "required": false, "type": "integer" }, { - "description": "the ID of the autoscale group", + "description": "list of scaledown autoscale policies", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups,updateAutoScaleVmGroup", - "required": true, - "type": "uuid" + "name": "scaledownpolicyids", + "related": "listAutoScalePolicies,updateAutoScalePolicy", + "required": false, + "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": "an optional field, whether to the display the group to the end user or not", "length": 255, - "name": "maxmembers", + "name": "fordisplay", "required": false, - "type": "integer" + "since": "4.4", + "type": "boolean" }, { "description": "list of scaleup autoscale policies", @@ -42586,11 +42864,12 @@ "type": "list" }, { - "description": "the frequency in which the performance counters to be collected", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "interval", + "name": "name", "required": false, - "type": "integer" + "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", @@ -42601,20 +42880,19 @@ "type": "string" }, { - "description": "list of scaledown autoscale policies", + "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": "scaledownpolicyids", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "name": "minmembers", "required": false, - "type": "list" + "type": "integer" } ], "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "response": [ { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", + "type": "string" }, { "description": "is group for display to the regular user", @@ -42622,23 +42900,13 @@ "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", + "description": "the autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "list of scaleup autoscale policies", - "name": "scaleuppolicies", - "type": "list" - }, - { - "description": "the public ip address", - "name": "publicip", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, { @@ -42647,19 +42915,14 @@ "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 autoscale vm group ID", - "name": "id", + "description": "the private port", + "name": "privateport", "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 name of the vm group", + "name": "domain", + "type": "string" }, { "description": "the project name of the vm group", @@ -42667,96 +42930,111 @@ "type": "string" }, { - "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 scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the domain ID of the vm group", + "name": "domainid", + "type": "string" }, + {}, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the account owning the vm group", - "name": "account", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", - "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": "the autoscale profile that contains information about the vms in the vm group.", + "name": "vmprofileid", "type": "string" }, { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, - {}, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "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 number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the private port", - "name": "privateport", - "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 autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "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 current state of the AutoScale Vm Group", + "name": "state", "type": "string" }, - {}, { - "description": "the public ip address id", - "name": "publicipid", + "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": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "description": "the public ip address id", + "name": "publicipid", + "type": "string" }, { - "description": "the domain ID of the vm group", - "name": "domainid", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" + }, + {}, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -42765,6 +43043,14 @@ "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, @@ -42773,18 +43059,14 @@ "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", @@ -42796,15 +43078,11 @@ "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" } ] }, @@ -42814,43 +43092,51 @@ "name": "listVirtualMachines", "params": [ { - "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 IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "name", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": false, + "since": "4.4", + "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": "the IDs of the virtual machines, mutually exclusive with id", + "description": "", "length": 255, - "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", + "name": "pagesize", "required": false, - "since": "4.4", - "type": "list" + "type": "integer" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "the host ID", "length": 255, - "name": "haenable", + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "since": "4.15", - "type": "boolean" + "type": "uuid" }, { - "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.", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "gpuenabled", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the availability zone ID", + "description": "the security group ID", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "securitygroupid", + "related": "createSecurityGroup,updateSecurityGroup", "required": false, + "since": "4.15", "type": "uuid" }, { @@ -42862,27 +43148,42 @@ "type": "boolean" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", "length": 255, - "name": "userdata", + "name": "haenable", "required": false, - "since": "4.18.0.0", + "since": "4.15", "type": "boolean" }, { - "description": "list vms by template", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "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", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "the group ID", + "length": 255, + "name": "groupid", + "related": "createInstanceGroup,updateInstanceGroup", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "tags", + "name": "showicon", "required": false, - "type": "map" + "since": "4.16.0.0", + "type": "boolean" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" }, { "description": "the cluster ID", @@ -42894,58 +43195,68 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "extensionid", + "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", "required": false, "type": "uuid" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "list by the service offering", + "description": "list by the backup offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "backupofferingid", + "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", "required": false, - "since": "4.4", + "since": "4.17", "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": "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": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "Whether to return only leased instances", + "description": "list vms by template", "length": 255, - "name": "leased", + "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", + "required": false, + "type": "uuid" + }, + { + "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": "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" }, { @@ -42956,11 +43267,11 @@ "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": "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": "details", + "name": "listall", "required": false, - "type": "list" + "type": "boolean" }, { "description": "the instances by userdata", @@ -42971,23 +43282,6 @@ "since": "4.20.1", "type": "uuid" }, - { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "createSecurityGroup,updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" - }, - { - "description": "list vms by vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": false, - "type": "uuid" - }, { "description": "CPU arch of the VM", "length": 255, @@ -42997,28 +43291,26 @@ "type": "string" }, { - "description": "the ID of the virtual machine", + "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": "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", + "name": "details", "required": false, - "type": "uuid" + "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": "Whether to return only leased instances", "length": 255, - "name": "listall", + "name": "leased", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "extensionid", - "related": "createExtension,listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "name": "forvirtualnetwork", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { "description": "the target hypervisor for the template", @@ -43028,18 +43320,20 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "makes the API's response contains only the resource count", + "description": "the availability zone ID", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "list resources by account. Must be used with the domainId parameter.", @@ -43049,66 +43343,57 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "the pod ID", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, + "since": "4.18.0", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this 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": "displayvm", + "name": "accumulate", "required": false, - "since": "4.4", + "since": "4.17.0", "type": "boolean" }, { - "description": "list by the backup offering", + "description": "the pod ID", "length": 255, - "name": "backupofferingid", - "related": "listBackupProviderOfferings,importBackupOffering,listBackupOfferings,updateBackupOffering", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, - "since": "4.17", "type": "uuid" }, { - "description": "the group ID", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "groupid", - "related": "createInstanceGroup,updateInstanceGroup", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 ID of the virtual machine", "length": 255, - "name": "accumulate", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, - "since": "4.17.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the host ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, @@ -43120,12 +43405,11 @@ "type": "integer" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list vms by vpc", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, - "since": "4.18.0", "type": "uuid" }, { @@ -43137,841 +43421,56 @@ "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 network id", + "description": "list by the service offering", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { - "description": "list vms by iso", + "description": "List by keyword", "length": 255, - "name": "isoid", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "description": "list by network id", "length": 255, - "name": "showicon", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "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", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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 name of the virtual machine", - "name": "name", - "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": "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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "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 alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "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": "NICs of the VNF appliance", "name": "vnfnics", "type": "list" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "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 the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "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": "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 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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "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 description of the affinity group", + "description": "the description of the security group", "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", - "type": "string" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "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": "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "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": "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": "publicipid", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "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": "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 account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "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 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": "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": "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" - } - ], - "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": "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 gateway of the nic", - "name": "gateway", - "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 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": "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 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" - }, { "description": "the list of egress rules associated with the security group", "name": "egressrule", @@ -43982,9 +43481,14 @@ "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" }, { "description": "the list of resource tags associated with the rule", @@ -43996,43 +43500,43 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44041,22 +43545,22 @@ "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 protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "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", + "type": "string" }, { "description": "the id of the security group rule", @@ -44069,15 +43573,10 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", + "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 starting IP of the security group rule", "name": "startport", @@ -44086,72 +43585,62 @@ ], "type": "set" }, - { - "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 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 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": "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": "tag value", - "name": "value", + "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": "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": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "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" }, { @@ -44160,36 +43649,26 @@ "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": "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "description": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -44197,46 +43676,96 @@ "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 protocol of the security group rule", - "name": "protocol", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "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", "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 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", + "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" + }, + { + "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 resource tags associated with the rule", "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -44245,23 +43774,23 @@ "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 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 id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -44270,745 +43799,937 @@ "type": "string" }, { - "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" } ], "type": "set" - }, - { - "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" } ], "type": "set" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" - } - ] - }, - { - "description": "Lists all available disk offerings.", - "isasync": false, - "name": "listDiskOfferings", - "params": [ - { - "description": "The ID of the volume, tags of the volume 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", - "required": false, - "since": "4.17", - "type": "uuid" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "id of zone disk offering is associated with", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": false, - "since": "4.13", - "type": "uuid" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": false, - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "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": "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": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", - "length": 255, - "name": "state", - "required": false, - "since": "4.19", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 password (if exists) of the virtual machine", + "name": "password", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "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 format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": false, - "since": "4.17", - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the storage type of the service offering. Values are local and shared.", - "length": 255, - "name": "storagetype", - "required": false, - "since": "4.19", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { - "description": "listed offerings support disk encryption", - "length": 255, - "name": "encrypt", - "required": false, - "since": "4.18", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, + {}, { - "description": "ID of the disk offering", - "length": 255, - "name": "id", - "related": "createDiskOffering,listDiskOfferings", - "required": false, - "type": "uuid" - } - ], - "related": "createDiskOffering", - "response": [ - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "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": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "unique ID of the disk offering", - "name": "id", + "description": "the state of the virtual machine", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the size of the disk offering in GB", - "name": "disksize", - "type": "long" + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "type": "long" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { - "description": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "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 project id of the vm", + "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", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "an alternate display text of the disk offering.", - "name": "displaytext", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "io requests write rate of the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the date this disk offering was created", - "name": "created", - "type": "date" + "description": "the project name of the vm", + "name": "project", + "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "description": "the id of userdata used for the VM", + "name": "userdataid", "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": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "state of the disk offering", - "name": "state", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "Whether disks using this offering will be encrypted on primary storage", - "name": "encrypt", - "type": "boolean" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, - {}, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "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 VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the vsphere storage policy tagged to the disk offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" - } - ] - }, - { - "description": "Deletes a Cisco ASA 1000v appliance", - "isasync": false, - "name": "deleteCiscoAsa1000vResource", - "params": [ - { - "description": "Cisco ASA 1000v resource ID", - "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": true, - "type": "uuid" - } - ], - "response": [ - {}, + }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" - } - ] - }, - { - "description": "Upgrades a running CloudManaged Kubernetes cluster", - "isasync": true, - "name": "upgradeKubernetesCluster", - "params": [ + }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", - "required": true, - "type": "uuid" + "description": "the list of resource tags associated", + "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", + "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": "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "the ID of the Kubernetes version for upgrade", - "length": 255, - "name": "kubernetesversionid", - "related": "addKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", - "required": true, - "type": "uuid" - } - ], - "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", - "response": [ + "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 domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", - "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 the template of the Kubernetes cluster", - "name": "templateid", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the date when this Kubernetes cluster was created", + "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "keypair details", - "name": "keypair", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, - {}, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "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 project name of the Kubernetes cluster", - "name": "project", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, { "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 network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", "type": "integer" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "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 description of the affinity group", + "name": "description", + "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": "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 project name of the affinity group", + "name": "project", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "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 type of the affinity group", + "name": "type", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" + }, + {}, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "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": "Minimum size of the cluster", - "name": "minsize", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "name": "size", - "type": "long" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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 ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "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 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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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 vpc to which the nic belongs", + "name": "vpcid", + "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 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 broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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": "name of the vpc to which the nic belongs", + "name": "vpcname", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" + } + ] + }, + { + "description": "Lists all available disk offerings.", + "isasync": false, + "name": "listDiskOfferings", + "params": [ + { + "description": "The ID of the volume, tags of the volume 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", + "required": false, + "since": "4.17", + "type": "uuid" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "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 id of the Kubernetes cluster", + "description": "ID of the disk offering", + "length": 255, "name": "id", - "type": "string" + "related": "createDiskOffering,listDiskOfferings", + "required": false, + "type": "uuid" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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": "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": false, + "since": "4.20.0", + "type": "uuid" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", - "type": "string" + "description": "id of zone disk offering is associated with", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "since": "4.13", + "type": "uuid" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Filter by state of the disk offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "length": 255, + "name": "state", + "required": false, + "since": "4.19", "type": "string" }, { - "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": "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": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", + "description": "listed offerings support disk encryption", + "length": 255, + "name": "encrypt", + "required": false, + "since": "4.18", "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", + "description": "name of the disk offering", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", - "type": "string" - } - ] - }, - { - "description": "Creates a condition for VM auto scaling", - "isasync": true, - "name": "createCondition", - "params": [ - { - "description": "ID of the Counter.", + "description": "The ID of the storage pool, tags of the storage pool are used to filter the offerings", "length": 255, - "name": "counterid", - "related": "createCounter,listCounters", - "required": true, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "an optional project for condition", + "description": "", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the account of the condition. Must be used with the domainId parameter.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the domain ID of the account.", + "description": "list only resources belonging to the domain specified", "length": 255, "name": "domainid", "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", @@ -45016,2039 +44737,1316 @@ "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.", + "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": "relationaloperator", - "required": true, - "type": "string" + "name": "listall", + "required": false, + "type": "boolean" } ], - "related": "listConditions", + "related": "createDiskOffering", "response": [ { - "description": "the domain id of the Condition owner", - "name": "domainid", - "type": "string" - }, - {}, - { - "description": "the id of the Condition", - "name": "id", - "type": "string" - }, - { - "description": "Threshold Value for the counter.", - "name": "threshold", + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "Details of the Counter.", - "name": "counter", - "type": "counterresponse" + "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 project name of the Condition", - "name": "project", + "description": "the vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "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 disk offering.", + "name": "displaytext", + "type": "string" }, { - "description": "path of the domain to which the Condition owner belongs", - "name": "domainpath", - "type": "string" + "description": "the min iops of the disk offering", + "name": "miniops", + "type": "long" }, { - "description": "the Id of the Counter.", - "name": "counterid", - "type": "string" + "description": "io requests read rate of the disk offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", "type": "string" }, { - "description": "the project id of the Condition.", - "name": "projectid", + "description": "the storage type for this disk offering", + "name": "storagetype", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "zone id of counter", + "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 owner of the Condition.", - "name": "account", - "type": "string" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the Name of the Counter.", - "name": "countername", - "type": "string" + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" }, { - "description": "the domain name of the owner.", - "name": "domain", - "type": "string" - } - ] - }, - { - "description": "Lists projects and provides detailed information for listed projects", - "isasync": false, - "name": "listProjects", - "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, + "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": "list projects by state", - "length": 255, - "name": "state", - "required": false, + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "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, + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", "type": "boolean" }, { - "description": "list projects by display text", - "length": 255, - "name": "displaytext", - "required": false, - "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": "List projects by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, + "description": "additional key/value details tied with this disk offering", + "name": "details", "type": "map" }, { - "description": "list projects by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", + "type": "long" }, { - "description": "List projects by username", - "length": 255, - "name": "username", - "required": false, - "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": "flag to display the resource icon for projects", - "length": 255, - "name": "showicon", - "required": false, + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "list projects by project ID", - "length": 255, + "description": "unique ID of the disk offering", "name": "id", - "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", - "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "response": [ + }, { - "description": "the total number of virtual machines deployed by this project", - "name": "vmtotal", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "the state of the project", - "name": "state", - "type": "string" + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", + "type": "long" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" + "description": "the name of the disk offering", + "name": "name", + "type": "string" }, + {}, { - "description": "the list of resource tags associated with vm", - "name": "tags", - "response": [ - { - "description": "tag key name", - "name": "key", - "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": "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": "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": "list" + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the total number of public ip addresses this project can acquire", - "name": "iplimit", + "description": "Whether disks using this offering will be encrypted on primary storage", + "name": "encrypt", + "type": "boolean" + }, + { + "description": "state of the disk offering", + "name": "state", "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "the total number of virtual machines stopped for this project", - "name": "vmstopped", + "description": "the size of the disk offering in GB", + "name": "disksize", + "type": "long" + } + ] + }, + { + "description": "Deletes a Cisco ASA 1000v appliance", + "isasync": false, + "name": "deleteCiscoAsa1000vResource", + "params": [ + { + "description": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": true, + "type": "uuid" + } + ], + "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 total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the project", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ] + }, + { + "description": "Upgrades a running CloudManaged Kubernetes cluster", + "isasync": true, + "name": "upgradeKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster,upgradeKubernetesCluster", + "required": true, + "type": "uuid" }, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the ID of the Kubernetes version for upgrade", + "length": 255, + "name": "kubernetesversionid", + "related": "addKubernetesSupportedVersion,getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "required": true, + "type": "uuid" + } + ], + "related": "createKubernetesCluster,startKubernetesCluster,scaleKubernetesCluster", + "response": [ + { + "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", - "type": "long" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, + {}, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "Maximum size of the cluster", + "name": "maxsize", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", - "type": "long" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", - "type": "string" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "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 total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, + {}, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "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", - "type": "string" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "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 total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "the total number of virtual machines running for this project", - "name": "vmrunning", - "type": "integer" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", "type": "string" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, - {}, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "keypair details", + "name": "keypair", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" } - ], - "since": "3.0.0" + ] }, { - "description": "Creates an account", - "isasync": false, - "name": "createAccount", + "description": "Creates a condition for VM auto scaling", + "isasync": true, + "name": "createCondition", "params": [ { - "description": "email", - "length": 255, - "name": "email", - "required": true, - "type": "string" - }, - { - "description": "firstname", - "length": 255, - "name": "firstname", - "required": true, - "type": "string" - }, - { - "description": "Creates the user under the specified domain.", + "description": "an optional project for condition", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "Creates the account under the specified role.", + "description": "ID of the Counter.", "length": 255, - "name": "roleid", - "related": "createRole,importRole,listRoles,updateRole", - "required": false, + "name": "counterid", + "related": "createCounter,listCounters", + "required": true, "type": "uuid" }, { - "description": "lastname", + "description": "Relational Operator to be used with threshold. Valid values are EQ, GT, LT, GE, LE.", "length": 255, - "name": "lastname", + "name": "relationaloperator", "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": "Value for which the Counter will be evaluated with the Operator selected.", "length": 255, - "name": "password", + "name": "threshold", "required": true, - "type": "string" + "type": "long" }, { - "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.", + "description": "the account of the condition. Must be used with the domainId parameter.", "length": 255, "name": "account", "required": false, "type": "string" }, { - "description": "Account UUID, required for adding account from external provisioning system", + "description": "the domain ID of the account.", "length": 255, - "name": "accountid", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, + "type": "uuid" + } + ], + "related": "listConditions", + "response": [ + { + "description": "the owner of the Condition.", + "name": "account", "type": "string" }, { - "description": "details for account used to store specific parameters", - "length": 255, - "name": "accountdetails", - "required": false, - "type": "map" + "description": "the Id of the Counter.", + "name": "counterid", + "type": "string" }, { - "description": "User UUID, required for adding account from external provisioning system", - "length": 255, - "name": "userid", - "required": false, + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "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": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, { - "description": "Unique username.", - "length": 255, - "name": "username", - "required": true, + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, { - "description": "Network domain for the account's networks", - "length": 255, - "name": "networkdomain", - "required": false, + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, + {}, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", - "length": 255, - "name": "accounttype", - "required": false, + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" - } - ], - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "response": [ - { - "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 the account can own", - "name": "gpulimit", + "description": "the project name of the Condition", + "name": "project", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the Name of the Counter.", + "name": "countername", + "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the list of users associated with account", - "name": "user", - "response": [ - { - "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 user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "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": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "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 is default, false otherwise", - "name": "isdefault", - "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" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "the user name", - "name": "username", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", - "type": "string" - }, - { - "description": "the user firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "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": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "type": "string" - } - ], - "type": "list" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Details of the Counter.", + "name": "counter", + "type": "counterresponse" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the id of the Condition", + "name": "id", "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", + "description": "the domain name of the owner.", + "name": "domain", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", "type": "string" - }, + } + ] + }, + { + "description": "Lists projects and provides detailed information for listed projects", + "isasync": false, + "name": "listProjects", + "params": [ { - "description": "the state of the account", - "name": "state", + "description": "list projects by name", + "length": 255, + "name": "name", + "required": false, "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" + "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 total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "List projects by username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "list projects by display text", + "length": 255, + "name": "displaytext", + "required": false, "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "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 total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "list projects by project ID", + "length": 255, + "name": "id", + "related": "listProjectAccounts,activateProject,createProject,listProjects,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "flag to display the resource icon for projects", + "length": 255, + "name": "showicon", + "required": false, + "type": "boolean" }, { - "description": "details for the account", - "name": "accountdetails", - "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": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "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": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "list projects by state", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "List projects by tags (key/value pairs)", + "length": 255, + "name": "tags", + "required": false, + "type": "map" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, + } + ], + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "response": [ { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "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", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "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 networks owned by project", + "name": "networktotal", + "type": "long" }, + {}, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total number of vpcs the project can own", + "name": "vpclimit", + "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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 deployed by this account", - "name": "vmtotal", - "type": "long" + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", + "type": "string" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", "type": "long" }, - {}, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, { - "description": "the total number of templates which can be created by this account", + "description": "the total number of templates which can be created by this project", "name": "templatelimit", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the account", - "name": "name", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "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 project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of buckets stored by this account", + "description": "the total number of buckets stored by this project", "name": "buckettotal", "type": "long" }, { - "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 public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { - "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 number of networks the account can own", - "name": "networklimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of gpus owned by account", + "description": "the total number of gpus owned by project", "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 total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "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 account", - "name": "vmlimit", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" - }, - { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - {}, - { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", - "type": "string" - }, - { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "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", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "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", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "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 total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the domain name where the project belongs to", + "name": "domain", "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", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, - {}, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the list of resource tags associated with vm", + "name": "tags", "response": [ { - "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 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": "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": "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" - }, - { - "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 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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 description of the security group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" - }, - { - "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": "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 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": "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": "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 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": "resource type", - "name": "resourcetype", - "type": "string" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "tag value", + "name": "value", + "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": "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 project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, - { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" - }, - { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" } ], - "type": "set" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "type": "list" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", + "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the total number of backups stored by this project", + "name": "backuptotal", "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, + {} + ], + "since": "3.0.0" + }, + { + "description": "Creates an account", + "isasync": false, + "name": "createAccount", + "params": [ { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "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": "the id of userdata used for the VM", - "name": "userdataid", + "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 write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Account UUID, required for adding account from external provisioning system", + "length": 255, + "name": "accountid", + "required": false, "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "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": "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 vm to which the nic belongs", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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", - "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 type of the nic", - "name": "type", - "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", - "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": "the cidr of IPv6 network", - "name": "ip6cidr", - "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": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "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", - "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": "the name of the corresponding network", - "name": "networkname", - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" - } - ], - "type": "set" + "description": "details for account used to store specific parameters", + "length": 255, + "name": "accountdetails", + "required": false, + "type": "map" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "Network domain for the account's networks", + "length": 255, + "name": "networkdomain", + "required": false, + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "Creates the user under the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "Unique username.", + "length": 255, + "name": "username", + "required": true, "type": "string" }, - {}, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "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 date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "User UUID, required for adding account from external provisioning system", + "length": 255, + "name": "userid", + "required": false, + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "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, + "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "email", + "length": 255, + "name": "email", + "required": true, "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "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": "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": "firstname", + "length": 255, + "name": "firstname", + "required": true, + "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "lastname", + "length": 255, + "name": "lastname", + "required": true, "type": "string" - }, + } + ], + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "response": [ { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { @@ -47057,207 +46055,135 @@ "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, - {}, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "true if account is default, false otherwise", + "name": "isdefault", "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 account was created", + "name": "created", + "type": "date" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "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": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "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": "tag value", - "name": "value", - "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 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", - "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 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 name of the virtual machine", - "name": "name", - "type": "string" + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "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" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { "description": "the total number of network traffic bytes sent", @@ -47265,753 +46191,1003 @@ "type": "long" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "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 vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the total number of buckets stored by this account", + "name": "buckettotal", + "type": "long" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "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 tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the total number of projects the account can own", + "name": "projectlimit", "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) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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 secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "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", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, - {}, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" }, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "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": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "Tungsten-Fabric service group protocol", - "length": 255, - "name": "protocol", - "required": true, + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "Tungsten-Fabric service group name", - "length": 255, - "name": "name", - "required": true, + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" }, { - "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", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "Tungsten-Fabric service group start port", - "name": "startport", - "type": "int" - }, - { - "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) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "Tungsten-Fabric service group end port", - "name": "endport", - "type": "int" + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric service group protocol", - "name": "protocol", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, - {}, { - "description": "Tungsten-Fabric service group name", - "name": "name", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "the list of users associated with account", + "name": "user", + "response": [ + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "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": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "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 api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "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", + "type": "boolean" + }, + { + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "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 account name of the user", + "name": "account", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + } + ], + "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the account", + "name": "name", "type": "string" } ] }, { - "description": "Recover a Shared FileSystem by id", - "isasync": false, - "name": "recoverSharedFileSystem", + "description": "Revert VM from a vmsnapshot.", + "isasync": true, + "name": "revertToVMSnapshot", "params": [ { - "description": "the ID of the shared filesystem to recover", + "description": "The ID of the vm snapshot", "length": 255, - "name": "id", - "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", - "required": false, + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, - {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", - "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": "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": "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": "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" + } + ], + "type": "set" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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" }, - {} - ], - "since": "4.20.0" - }, - { - "description": "Registers an existing ISO into the CloudStack Cloud.", - "isasync": false, - "name": "registerIso", - "params": [ { - "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": "checksum", - "required": false, + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "an optional account name. Must be used with domainId.", - "length": 255, + "description": "the account associated with the virtual machine", "name": "account", - "required": false, "type": "string" }, { - "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", - "length": 255, - "name": "directdownload", - "required": false, - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "Register ISO for the project", - "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": false, - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the URL to where the ISO is currently being hosted", - "length": 2048, - "name": "url", - "required": true, + "description": "the name of userdata used for the VM", + "name": "userdataname", "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", - "length": 255, - "name": "ostypeid", - "related": "addGuestOs", - "required": false, - "type": "uuid" + "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", - "length": 255, - "name": "name", - "required": true, + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, + {}, { - "description": "the ID of the zone you wish to register the ISO to.", - "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "true if password reset feature is supported; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "true if you want this ISO to be featured", - "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the display text of the ISO, defaults to the 'name'", - "length": 4096, - "name": "displaytext", - "required": false, + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Image store UUID", - "length": 255, - "name": "imagestoreuuid", - "required": false, + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", - "length": 255, - "name": "bootable", - "required": false, - "type": "boolean" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", - "length": 255, - "name": "isdynamicallyscalable", - "required": false, - "type": "boolean" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "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": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, { - "description": "the status of the template", - "name": "status", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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 secondary storage host for the template", - "name": "hostid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "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": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, + {}, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the project id of the template", + "description": "the project id of the vm", "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the size of the template", - "name": "size", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "resource type", - "name": "resourcetype", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", + "type": "string" + }, + { + "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": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "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", "type": "string" } ], "type": "set" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, - {}, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the template", - "name": "templatetype", + "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" }, - {}, { - "description": "the physical size of the template", - "name": "physicalsize", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", - "type": "boolean" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", - "type": "boolean" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "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 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 type of the affinity group", + "name": "type", + "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": "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 ID of the affinity group", + "name": "id", + "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { @@ -48020,158 +47196,525 @@ "type": "resourceiconresponse" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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": "OS type id of the vm", + "name": "ostypeid", "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "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 name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", "type": "list" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "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 amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" - } - ] - }, - { - "description": "Lists Cisco ASA 1000v appliances", - "isasync": false, - "name": "listCiscoAsa1000vResources", - "params": [ + }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", - "length": 255, - "name": "hostname", - "required": false, + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "Cisco ASA 1000v resource ID", - "length": 255, - "name": "resourceid", - "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", - "required": false, - "type": "uuid" - } - ], - "related": "addCiscoAsa1000vResource", - "response": [ + "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", - "type": "integer" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, - {}, - {}, - {}, - {}, { - "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 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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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": "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 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 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": "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 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": "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": "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", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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" + } + ], + "type": "set" + }, + { + "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 description of the security group", + "name": "description", + "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 id of the security group rule", + "name": "ruleid", + "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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 project id the tag belongs to", + "name": "projectid", + "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": "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" + } + ], + "type": "set" + }, + { + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "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 protocol of the security group rule", + "name": "protocol", + "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 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 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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "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 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" + } + ], + "type": "set" + }, + { + "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" + } + ], + "type": "set" + } + ], + "since": "4.2.0" }, { - "description": "deletes a range of portable public IP's associated with a region", + "description": "Removes a Guest OS Mapping.", "isasync": true, - "name": "deletePortableIpRange", + "name": "removeGuestOsMapping", "params": [ { - "description": "Id of the portable ip range", + "description": "ID of the guest OS mapping", "length": 255, "name": "id", - "related": "createPortableIpRange", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", "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", @@ -48183,73 +47726,132 @@ "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" }, { - "description": "Upgrades router to use newer template", - "isasync": false, - "name": "upgradeRouterTemplate", + "description": "create Tungsten-Fabric service group", + "isasync": true, + "name": "createTungstenFabricServiceGroup", "params": [ { - "description": "upgrades all routers within the specified pod", + "description": "Tungsten-Fabric service group start port", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "name": "startport", + "required": true, + "type": "integer" }, { - "description": "upgrades all routers owned by the specified account", + "description": "Tungsten-Fabric service group protocol", "length": 255, - "name": "account", - "required": false, + "name": "protocol", + "required": true, "type": "string" }, { - "description": "upgrades all routers within the specified cluster", + "description": "the ID of zone", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, "type": "uuid" }, { - "description": "upgrades all routers owned by the specified domain", + "description": "Tungsten-Fabric service group name", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "upgrades router with the specified Id", + "description": "Tungsten-Fabric service group end port", "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": false, - "type": "uuid" + "name": "endport", + "required": true, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric service group name", + "name": "name", + "type": "string" }, { - "description": "upgrades all routers within the specified zone", - "length": 255, + "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", + "type": "integer" + }, + { + "description": "Tungsten-Fabric service group protocol", + "name": "protocol", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Tungsten-Fabric service group start port", + "name": "startport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {}, + { + "description": "Tungsten-Fabric service group end port", + "name": "endport", + "type": "int" + }, + { + "description": "Tungsten-Fabric provider zone id", "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "type": "long" + } + ] + }, + { + "description": "Recover a Shared FileSystem by id", + "isasync": false, + "name": "recoverSharedFileSystem", + "params": [ + { + "description": "the ID of the shared filesystem to recover", + "length": 255, + "name": "id", + "related": "listSharedFileSystems,startSharedFileSystem,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": false, "type": "uuid" } ], - "related": "", "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" }, { @@ -48257,415 +47859,724 @@ "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.20.0" }, { - "description": "Lists IPv4 subnets for guest networks.", + "description": "Registers an existing ISO into the CloudStack Cloud.", "isasync": false, - "name": "listIpv4SubnetsForGuestNetwork", + "name": "registerIso", "params": [ { - "description": "UUID of zone to which the IPv4 subnet belongs to.", + "description": "true if password reset feature is supported; default is false", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "UUID of VPC to which the IPv4 subnet is associated to.", + "description": "an optional account name. Must be used with domainId.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "UUID of zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "parentid", - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "UUID of the IPv4 subnet for guest network.", + "description": "Register ISO for the project", "length": 255, - "name": "id", - "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" }, { - "description": "", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "page", + "name": "ispublic", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "List by keyword", + "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "keyword", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { - "description": "", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "pagesize", + "name": "bootable", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The CIDR of the Ipv4 subnet.", + "description": "the name of the ISO", "length": 255, - "name": "subnet", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "UUID of network to which the IPv4 subnet is associated 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": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "ostypeid", + "related": "addGuestOs", "required": false, "type": "uuid" - } - ], - "related": "createIpv4SubnetForGuestNetwork", - "response": [ + }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", - "type": "string" + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if ISO contains XS/VMWare tools inorder to support dynamic scaling of VM CPU/memory", + "length": 255, + "name": "isdynamicallyscalable", + "required": false, + "type": "boolean" }, { - "description": "Name of the VPC which the IPv4 subnet is associated with.", - "name": "vpcname", + "description": "the display text of the ISO, defaults to the 'name'", + "length": 4096, + "name": "displaytext", + "required": false, "type": "string" }, - {}, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", - "type": "string" + "description": "the ID of the zone you wish to register the ISO to.", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "Image store UUID", + "length": 255, + "name": "imagestoreuuid", + "required": false, "type": "string" }, { - "description": "id of the data center IPv4 subnet", - "name": "parentid", - "type": "string" + "description": "true if ISO should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" }, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", + "description": "the URL to where the ISO is currently being hosted", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "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": "checksum", + "required": false, "type": "string" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ + { + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", + "description": "the date this template was created", "name": "created", "type": "date" }, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "type": "date" + "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", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", + "description": "the ID of the zone for this template", + "name": "zoneid", "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "CPU Arch of the host", - "name": "arch", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the host version", - "name": "version", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the project name of the template", + "name": "project", + "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "The name of extension for this cluster", + "description": "The name of extension linked to this template", "name": "extensionname", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "checksum of the template", + "name": "checksum", + "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the Zone ID of the host", - "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": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, + {}, { - "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 management server ID of the host", - "name": "managementserverid", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "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 extension for this cluster", - "name": "extensionid", + "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": "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" + }, + { + "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": "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" + } + ], + "type": "set" + }, + {}, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the status of the template", + "name": "status", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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": "the state of the host", - "name": "state", - "type": "status" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "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 IP address of the host", - "name": "ipaddress", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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 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 host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the name of userdata linked to this template", + "name": "userdataname", "type": "string" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" + } + ] + }, + { + "description": "Lists Cisco ASA 1000v appliances", + "isasync": false, + "name": "listCiscoAsa1000vResources", + "params": [ + { + "description": "Cisco ASA 1000v resource ID", + "length": 255, + "name": "resourceid", + "related": "addCiscoAsa1000vResource,listCiscoAsa1000vResources", + "required": false, + "type": "uuid" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "Hostname or ip address of the Cisco ASA 1000v appliance.", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "addCiscoAsa1000vResource", + "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": "deletes a range of portable public IP's associated with a region", + "isasync": true, + "name": "deletePortableIpRange", + "params": [ + { + "description": "Id of the portable ip range", + "length": 255, + "name": "id", + "related": "createPortableIpRange", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "true if operation is executed successfully", + "name": "success", "type": "boolean" }, + {}, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, + { + "description": "Upgrades router to use newer template", + "isasync": false, + "name": "upgradeRouterTemplate", + "params": [ + { + "description": "upgrades router with the specified Id", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": false, + "type": "uuid" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "upgrades all routers owned by the specified account", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "upgrades all routers owned by the specified domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified zone", + "length": 255, + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, + { + "description": "upgrades all routers within the specified pod", + "length": 255, + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": false, + "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": "Cancels host maintenance.", + "isasync": true, + "name": "cancelHostMaintenance", + "params": [ + { + "description": "the host ID", + "length": 255, + "name": "id", + "related": "addBaremetalHost,addHost,cancelHostMaintenance,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": true, + "type": "uuid" + } + ], + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "response": [ + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { @@ -48673,11 +48584,15 @@ "name": "networkkbswrite", "type": "long" }, - {}, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { "description": "the amount of the host's memory currently allocated", @@ -48685,51 +48600,90 @@ "type": "long" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "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": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, + { + "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 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 Zone name of the host", - "name": "zonename", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "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": "Used GPUs on the Host", - "name": "gpuused", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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 resource state of the host", - "name": "resourcestate", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" }, + { + "description": "the Pod ID of the host", + "name": "podid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, { "description": "GPU cards present in the host", "name": "gpugroup", @@ -48739,13 +48693,13 @@ "name": "vgpu", "response": [ { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -48754,28 +48708,28 @@ "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", + "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": "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" } ], @@ -48790,43 +48744,149 @@ "type": "list" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the host version", + "name": "version", "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 is disconnected. False otherwise.", - "name": "disconnected", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 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 name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", + "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": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "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 amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "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 after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", + "type": "string" + }, + {}, + { + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" + }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { @@ -48834,50 +48894,117 @@ "name": "cpuallocatedpercentage", "type": "string" }, + { + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, { "description": "comma-separated list of storage access groups on the pod", "name": "podstorageaccessgroups", "type": "string" }, + {}, { - "description": "the CPU number of the host", - "name": "cpunumber", + "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 host type", + "name": "type", + "type": "type" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "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 admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" + }, + {}, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" + }, + { + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" } ] }, @@ -48887,27 +49014,35 @@ "name": "listVlanIpRanges", "params": [ { - "description": "project who will own the VLAN", + "description": "the Zone ID of the VLAN IP range", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "name": "zoneid", + "related": "createZone,updateZone,listZones,listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the VLAN IP range", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "network id of the VLAN IP range", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the account with which the VLAN IP range is associated. Must be used with the domainId parameter.", @@ -48917,17 +49052,18 @@ "type": "string" }, { - "description": "", + "description": "the ID of the VLAN IP range", "length": 255, - "name": "page", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,listVlanIpRanges,dedicatePublicIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the domain ID with which the VLAN IP range is associated. If used with the account parameter, returns all VLAN IP ranges for that account in the specified domain.", + "description": "the Pod ID of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", "required": false, "type": "uuid" }, @@ -48947,59 +49083,51 @@ "type": "uuid" }, { - "description": "network id of the VLAN IP range", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": false, - "type": "uuid" - }, - { - "description": "the Pod ID of the VLAN IP range", + "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "name": "vlan", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the ID or VID of the VLAN. Default is an \"untagged\" VLAN.", + "description": "project who will own the VLAN", "length": 255, - "name": "vlan", + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "", "length": 255, - "name": "zoneid", - "related": "createZone,updateZone,listZones,listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "response": [ + {}, { - "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 domain ID of the VLAN IP range", - "name": "domainid", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { @@ -49008,26 +49136,10 @@ "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the description of the VLAN IP range", - "name": "description", - "type": "string" - }, - { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "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", @@ -49044,44 +49156,49 @@ "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, {}, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" }, { - "description": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the domain name of the VLAN IP range", + "name": "domain", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -49090,14 +49207,14 @@ "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the project name of the vlan range", + "name": "project", + "type": "string" }, { "description": "indicates to which provider the IP range is dedicated to", @@ -49105,13 +49222,13 @@ "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", - "type": "string" + "description": "the virtual network for the VLAN IP range", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { @@ -49120,14 +49237,24 @@ "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "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 description of the VLAN IP range", + "name": "description", + "type": "string" + }, + { + "description": "the project id of the vlan range", + "name": "projectid", + "type": "string" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" } ] }, @@ -49137,30 +49264,23 @@ "name": "updateZone", "params": [ { - "description": "the second internal DNS for the Zone", - "length": 255, - "name": "internaldns2", - "required": false, - "type": "string" - }, - { - "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": "Network domain name for the networks in the zone; empty string will update domain with NULL value", "length": 255, - "name": "allocationstate", + "name": "domain", "required": false, "type": "string" }, { - "description": "the second DNS for the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "dns2", + "name": "dns1", "required": false, "type": "string" }, @@ -49172,61 +49292,60 @@ "type": "string" }, { - "description": "the second DNS for IPv6 network in the Zone", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "ip6dns2", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "Network domain name for the networks in the zone; empty string will update domain with NULL value", + "description": "the details for the Zone", "length": 255, - "name": "domain", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "description": "the dns search order list", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "dnssearchorder", + "name": "localstorageenabled", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "the second DNS for the Zone", "length": 255, - "name": "localstorageenabled", + "name": "dns2", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "guestcidraddress", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the details for the Zone", + "description": "the second DNS for IPv6 network in the Zone", "length": 255, - "name": "details", + "name": "ip6dns2", "required": false, - "type": "map" + "type": "string" }, { - "description": "sort key of the zone, integer", + "description": "the dns search order list", "length": 255, - "name": "sortkey", + "name": "dnssearchorder", "required": false, - "type": "integer" + "type": "list" }, { - "description": "the ID of the Zone", + "description": "the dhcp Provider for the Zone", "length": 255, - "name": "id", - "related": "createZone,updateZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "dhcpprovider", + "required": false, + "type": "string" }, { "description": "updates a private zone to public if set, but not vice-versa", @@ -49236,16 +49355,17 @@ "type": "boolean" }, { - "description": "the first DNS for IPv6 network in the Zone", + "description": "the ID of the Zone", "length": 255, - "name": "ip6dns1", - "required": false, - "type": "string" + "name": "id", + "related": "createZone,updateZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the first DNS for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "dns1", + "name": "internaldns2", "required": false, "type": "string" }, @@ -49255,113 +49375,134 @@ "name": "internaldns1", "required": false, "type": "string" + }, + { + "description": "the first DNS for IPv6 network in the Zone", + "length": 255, + "name": "ip6dns1", + "required": false, + "type": "string" } ], "related": "createZone,listZones,listZones", "response": [ { - "description": "the second IPv6 DNS for the Zone", - "name": "ip6dns2", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" }, { - "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" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "External network provider if any", + "name": "provider", "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", "type": "string" }, { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" + "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 first internal DNS for the Zone", + "name": "internaldns1", "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", + "type": "string" }, - {}, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "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 zone.", "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 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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -49369,19 +49510,14 @@ "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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -49390,35 +49526,107 @@ "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": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, + { + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" + }, + {}, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + {}, + { + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "the display text of the zone", + "name": "displaytext", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" + }, + { + "description": "Zone id", + "name": "id", + "type": "string" + }, + { + "description": "Used GPUs in the Zone", + "name": "gpuused", + "type": "long" + }, { "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", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { @@ -49427,28 +49635,28 @@ "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in allocated", + "name": "capacityallocated", "type": "long" }, { @@ -49457,13 +49665,13 @@ "type": "short" }, { - "description": "the capacity name", - "name": "name", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { @@ -49472,114 +49680,33 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" } ], "type": "list" }, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" - }, - { - "description": "AS Number Range", - "name": "asnrange", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "the display text of the zone", - "name": "displaytext", - "type": "string" - }, - { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" }, { "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 guest CIDR address for the Zone", - "name": "guestcidraddress", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Used GPUs in the Zone", - "name": "gpuused", - "type": "long" - }, - { - "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": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" - }, - { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" - }, - { - "description": "Zone name", - "name": "name", - "type": "string" - }, - { - "description": "External network provider if any", - "name": "provider", - "type": "string" - }, - { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" - }, - { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, - { - "description": "the second DNS for the Zone", - "name": "dns2", - "type": "string" - }, - {} + } ] }, { @@ -49588,17 +49715,18 @@ "name": "extractVolume", "params": [ { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the zone where the volume is located", "length": 255, - "name": "mode", + "name": "zoneid", + "related": "createZone,listZones,listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the zone where the volume is located", + "description": "the ID of the volume", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", + "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" }, @@ -49610,78 +49738,77 @@ "type": "string" }, { - "description": "the ID of the volume", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "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": "mode", "required": true, - "type": "uuid" + "type": "string" } ], "related": "extractIso,extractSnapshot,extractTemplate,downloadImageStoreObject", "response": [ { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the id of extracted object", + "name": "id", "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 mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the state of the extracted object", - "name": "state", + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the status of the extraction", + "name": "status", "type": "string" }, {}, { - "description": "", - "name": "resultstring", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, - {}, { "description": "the time and date the object 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 name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the id of extracted object", - "name": "id", - "type": "string" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the name of the extracted object", - "name": "name", + "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", @@ -49693,52 +49820,96 @@ "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "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", + "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" } ] }, { - "description": "Releases an existing dedicated IPv4 subnet for a zone.", - "isasync": true, - "name": "releaseIpv4SubnetForZone", + "description": "Lists IPv4 subnets for guest networks.", + "isasync": false, + "name": "listIpv4SubnetsForGuestNetwork", "params": [ { - "description": "Id of the guest network IPv4 subnet", + "description": "", "length": 255, - "name": "id", + "name": "pagesize", + "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": true, + "required": false, "type": "uuid" - } - ], - "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "response": [ + }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, - {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "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 CIDR of the Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "UUID of the IPv4 subnet for guest network.", + "length": 255, + "name": "id", + "related": "createIpv4SubnetForGuestNetwork,listIpv4SubnetsForGuestNetwork", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": false, + "type": "uuid" + } + ], + "related": "createIpv4SubnetForGuestNetwork", + "response": [ + { + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { @@ -49747,28 +49918,50 @@ "type": "string" }, { - "description": "name 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": "id of the guest IPv4 subnet", - "name": "id", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" + }, + {}, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "Name of the VPC which the IPv4 subnet is associated with.", + "name": "vpcname", + "type": "string" + }, + { + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" }, { @@ -49776,11 +49969,25 @@ "name": "created", "type": "date" }, - {}, { - "description": "guest IPv4 subnet", + "description": "id of the IPv4 subnet for guest network", + "name": "id", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -49790,13 +49997,6 @@ "isasync": false, "name": "listProjectAccounts", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -49813,19 +50013,26 @@ "type": "uuid" }, { - "description": "ID of the project", + "description": "list invitation by user ID", "length": 255, - "name": "projectid", - "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", - "required": true, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": false, "type": "uuid" }, { - "description": "list invitation by user ID", + "description": "list accounts of the project by role", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "name": "role", "required": false, + "type": "string" + }, + { + "description": "ID of the project", + "length": 255, + "name": "projectid", + "related": "listProjectAccounts,activateProject,createProject,suspendProject,updateProject", + "required": true, "type": "uuid" }, { @@ -49836,16 +50043,16 @@ "type": "integer" }, { - "description": "list accounts of the project by account name", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list accounts of the project by role", + "description": "list accounts of the project by account name", "length": 255, - "name": "role", + "name": "account", "required": false, "type": "string" } @@ -49853,18 +50060,53 @@ "related": "activateProject,createProject,suspendProject,updateProject", "response": [ { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", + "type": "long" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "type": "string" + }, + { + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { @@ -49873,84 +50115,85 @@ "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "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 number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, + {}, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the name of the project", + "name": "name", + "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "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 primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total number of public ip addresses this project can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this project", - "name": "iptotal", - "type": "long" + "description": "the total number of buckets available to this project", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { "description": "the total number of virtual machines running for this project", @@ -49958,39 +50201,35 @@ "type": "integer" }, { - "description": "the date this project was created", - "name": "created", - "type": "date" - }, - { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the id of the project", + "name": "id", + "type": "string" }, { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, + {}, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { "description": "the total object storage space (in GiB) available to the project", @@ -49998,23 +50237,23 @@ "type": "string" }, { - "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", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "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 project", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, { @@ -50023,8 +50262,8 @@ "type": "long" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { @@ -50033,59 +50272,54 @@ "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the id of the project", - "name": "id", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "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) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "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 vm", "name": "tags", "response": [ - { - "description": "tag key name", - "name": "key", - "type": "string" - }, { "description": "id of the resource", "name": "resourceid", @@ -50097,18 +50331,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -50117,193 +50351,130 @@ "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 domain associated with the tag", + "name": "domain", "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, - {}, { - "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 project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "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", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "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", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", - "type": "string" + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", - "type": "string" - }, { "description": "the total backup storage space (in GiB) owned by the project", "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" - }, - { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", - "type": "long" } ], "since": "3.0.0" }, { - "description": "Updates an existing autoscale policy.", + "description": "Releases an existing dedicated IPv4 subnet for a zone.", "isasync": true, - "name": "updateAutoScalePolicy", + "name": "releaseIpv4SubnetForZone", "params": [ { - "description": "the duration in which the conditions have to be true before action is taken", - "length": 255, - "name": "duration", - "required": false, - "type": "integer" - }, - { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, - { - "description": "the ID of the autoscale policy", + "description": "Id of the guest network IPv4 subnet", "length": 255, "name": "id", - "related": "listAutoScalePolicies,updateAutoScalePolicy", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone,releaseIpv4SubnetForZone", "required": true, "type": "uuid" - }, - { - "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", - "length": 255, - "name": "conditionids", - "related": "listConditions", - "required": false, - "type": "list" } ], - "related": "listAutoScalePolicies", + "related": "createIpv4SubnetForZone,listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", "response": [ { - "description": "the project id autoscale policy", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "the account owning the autoscale policy", - "name": "account", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, - {}, { - "description": "the domain name of the autoscale policy", - "name": "domain", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { @@ -50312,158 +50483,164 @@ "type": "integer" }, { - "description": "the project name of the autoscale policy", - "name": "project", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, + {}, { - "description": "name of the autoscale policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", - "name": "action", + "description": "guest IPv4 subnet", + "name": "subnet", "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": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the project name of the IPv4 subnet", + "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 account of the IPv4 subnet", + "name": "account", + "type": "string" }, + {}, { - "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 IPv4 subnet", + "name": "domainid", + "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" } - ] + ], + "since": "4.20.0" }, { - "description": "Creates a IPv4 subnet for a zone.", + "description": "Updates an existing autoscale policy.", "isasync": true, - "name": "createIpv4SubnetForZone", + "name": "updateAutoScalePolicy", "params": [ { - "description": "project who will own the IPv4 subnet", + "description": "the list of IDs of the conditions that are being evaluated on every interval", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject,updateProject", + "name": "conditionids", + "related": "listConditions", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "The CIDR of the IPv4 subnet.", + "description": "the ID of the autoscale policy", "length": 255, - "name": "subnet", + "name": "id", + "related": "listAutoScalePolicies,updateAutoScalePolicy", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the IPv4 subnet", + "description": "the duration in which the conditions have to be true before action is taken", "length": 255, - "name": "account", + "name": "duration", "required": false, - "type": "string" + "type": "integer" }, { - "description": "UUID of the zone which the IPv4 subnet belongs to.", + "description": "the cool down period in which the policy should not be evaluated after the action has been taken", "length": 255, - "name": "zoneid", - "related": "createZone,listZones,listZones", - "required": true, - "type": "uuid" + "name": "quiettime", + "required": false, + "type": "integer" }, { - "description": "domain ID of the account owning the IPv4 subnet", + "description": "the name of the autoscale policy", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "name", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" } ], - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "related": "listAutoScalePolicies", "response": [ { - "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": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" + "description": "the list of IDs of the conditions that are being evaluated on every interval", + "name": "conditions", + "type": "list" }, - {}, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", - "type": "string" + "description": "the duration for which the conditions have to be true before action is taken", + "name": "duration", + "type": "integer" }, {}, { - "description": "the domain ID of the IPv4 subnet", - "name": "domainid", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the cool down period for which the policy should not be evaluated after the action has been taken", + "name": "quiettime", "type": "integer" }, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "path of the domain to which the autoscale policy belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", + "name": "action", "type": "string" }, { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the autoscale policy", + "name": "name", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" - } - ], - "since": "4.20.0" + }, + { + "description": "the domain ID of the autoscale policy", + "name": "domainid", + "type": "string" + }, + {} + ] }, { "description": "Creates a disk offering.", @@ -50471,78 +50648,70 @@ "name": "createDiskOffering", "params": [ { - "description": "the storage type of the disk offering. Values are local and shared.", + "description": "name of the disk offering", "length": 255, - "name": "storagetype", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "An alternate display text of the disk offering, defaults to 'name'.", - "length": 4096, - "name": "displaytext", + "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "length": 255, + "name": "disksize", "required": false, - "type": "string" + "type": "long" }, { - "description": "Volumes using this offering should be encrypted", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "encrypt", + "name": "provisioningtype", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "cachemode", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.14", - "type": "string" + "type": "integer" }, { - "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": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "disksizestrictness", + "name": "storagepolicy", + "related": "listVsphereStoragePolicies", "required": false, - "since": "4.17", - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { "description": "length (in seconds) of the burst", "length": 255, - "name": "iopswriteratemaxlength", + "name": "bytesreadratemaxlength", "required": false, "type": "long" }, { - "description": "name of the disk offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "description": "burst bytes read rate of the disk offering", "length": 255, - "name": "provisioningtype", + "name": "bytesreadratemax", "required": false, - "type": "string" + "type": "long" }, { - "description": "size of the disk offering in GB (1GB = 1,073,741,824 bytes)", + "description": "whether disk offering iops is custom or not", "length": 255, - "name": "disksize", + "name": "customizediops", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "details to specify disk offering parameters", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "details", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.16", - "type": "map" + "type": "list" }, { "description": "the ID of the containing zone(s), null for public offerings", @@ -50554,62 +50723,63 @@ "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, - "type": "list" - }, - { - "description": "whether disk offering size is custom or not", + "description": "details to specify disk offering parameters", "length": 255, - "name": "customized", + "name": "details", "required": false, - "type": "boolean" + "since": "4.16", + "type": "map" }, { - "description": "burst requests read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "iopsreadratemax", + "name": "iopsreadratemaxlength", "required": false, "type": "long" }, { - "description": "an optional field, whether to display the offering to the end user or not.", + "description": "Volumes using this offering should be encrypted", "length": 255, - "name": "displayoffering", + "name": "encrypt", "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "description": "the storage type of the disk offering. Values are local and shared.", "length": 255, - "name": "byteswriteratemax", + "name": "storagetype", "required": false, - "type": "long" + "type": "string" }, { - "description": "length (in seconds) of the burst", - "length": 255, - "name": "bytesreadratemaxlength", + "description": "tags for the disk offering", + "length": 4096, + "name": "tags", "required": false, - "type": "long" + "type": "string" }, { - "description": "max iops of the disk offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "maxiops", + "name": "iopswriterate", "required": false, "type": "long" }, + { + "description": "An alternate display text of the disk offering, defaults to 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "burst io requests write rate of the disk offering", "length": 255, @@ -50618,53 +50788,54 @@ "type": "long" }, { - "description": "burst bytes read rate of the disk offering", + "description": "length (in seconds) of the burst", "length": 255, - "name": "bytesreadratemax", + "name": "iopswriteratemaxlength", "required": false, "type": "long" }, { - "description": "io requests write rate of the disk offering", + "description": "min iops of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "miniops", "required": false, "type": "long" }, { - "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": "bytes read rate of the disk offering", + "description": "max iops of the disk offering", "length": 255, - "name": "bytesreadrate", + "name": "maxiops", "required": false, "type": "long" }, { - "description": "bytes write rate of the disk offering", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "byteswriterate", + "name": "bytesreadrate", "required": false, "type": "long" }, { - "description": "whether disk offering iops is custom or not", + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", "length": 255, - "name": "customizediops", + "name": "cachemode", "required": false, - "type": "boolean" + "since": "4.14", + "type": "string" }, { - "description": "tags for the disk offering", - "length": 4096, - "name": "tags", + "description": "an optional field, whether to display the offering to the end user or not.", + "length": 255, + "name": "displayoffering", "required": false, - "type": "string" + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -50674,25 +50845,31 @@ "type": "long" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "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": "storagepolicy", - "related": "listVsphereStoragePolicies", + "name": "disksizestrictness", "required": false, - "since": "4.15", - "type": "uuid" + "since": "4.17", + "type": "boolean" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "iopsreadrate", "required": false, - "type": "integer" + "type": "long" }, { - "description": "min iops of the disk offering", + "description": "whether disk offering size is custom or not", "length": 255, - "name": "miniops", + "name": "customized", + "required": false, + "type": "boolean" + }, + { + "description": "bytes write rate of the disk offering", + "length": 255, + "name": "byteswriterate", "required": false, "type": "long" } @@ -50700,208 +50877,319 @@ "related": "", "response": [ { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", + "type": "string" + }, + { + "description": "additional key/value details tied with this disk offering", + "name": "details", + "type": "map" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "unique ID of the disk offering", + "name": "id", + "type": "string" + }, + { + "description": "io requests write rate of the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the vsphere storage policy tagged to the disk 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 date this disk offering was created", - "name": "created", - "type": "date" + "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": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "bytes read rate of the disk offering", - "name": "diskBytesReadRate", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "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 disk offering", - "name": "diskIopsWriteRate", + "description": "whether to display the offering to the end user or not.", + "name": "displayoffering", + "type": "boolean" + }, + { + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, + {}, + {}, { - "description": "state of the disk offering", - "name": "state", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" + }, + { + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zone", + "description": "true if disk offering uses custom size, false otherwise", + "name": "iscustomized", + "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 vsphere storage policy tagged to the disk offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "bytes write rate of the disk offering", - "name": "diskBytesWriteRate", + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", "type": "long" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "name": "cacheMode", + "type": "string" + }, + { + "description": "bytes read rate of the disk offering", + "name": "diskBytesReadRate", "type": "long" }, + { + "description": "state of the disk offering", + "name": "state", + "type": "string" + }, { "description": "Whether disks using this offering will be encrypted on primary storage", "name": "encrypt", "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": "diskBytesReadRateMaxLength", "type": "long" }, - {}, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", + "type": "long" + }, + { + "description": "bytes write rate of the disk offering", + "name": "diskBytesWriteRate", + "type": "long" + }, { "description": "the size of the disk offering in GB", "name": "disksize", "type": "long" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the storage type for this disk offering", + "name": "storagetype", + "type": "string" }, { "description": "burst io requests read rate of the disk offering", "name": "diskIopsReadRateMax", "type": "long" }, - {}, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the name of the disk offering", + "name": "name", + "type": "string" + }, + { + "description": "io requests read rate of the disk 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": "an alternate display text of the disk offering.", "name": "displaytext", "type": "string" }, { - "description": "additional key/value details tied with this disk offering", - "name": "details", - "type": "map" + "description": "the date this disk offering was created", + "name": "created", + "type": "date" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", + "description": "the tags for the disk offering", + "name": "tags", "type": "string" }, { - "description": "the storage type for this disk offering", - "name": "storagetype", - "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", + "description": "the zone name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zone", "type": "string" - }, + } + ] + }, + { + "description": "Creates a IPv4 subnet for a zone.", + "isasync": true, + "name": "createIpv4SubnetForZone", + "params": [ { - "description": "unique ID of the disk offering", - "name": "id", + "description": "The CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": true, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "UUID of the zone which the IPv4 subnet belongs to.", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "project who will own the IPv4 subnet", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": false, + "type": "uuid" }, { - "description": "Returns true if the disk offering is suitable for the given virtual machine for disk creation otherwise false", - "name": "suitableforvirtualmachine", - "type": "boolean" + "description": "account who will own the IPv4 subnet", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + } + ], + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "response": [ + { + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" }, { - "description": "io requests read rate of the disk offering", - "name": "diskIopsReadRate", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the tags for the disk offering", - "name": "tags", + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", "type": "string" }, { - "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "zoneid", + "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", + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, { - "description": "the name of the disk offering", - "name": "name", + "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": "true if disk offering uses custom size, false otherwise", - "name": "iscustomized", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "whether to display the offering to the end user or not.", - "name": "displayoffering", - "type": "boolean" + "description": "id of the guest IPv4 subnet", + "name": "id", + "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": "the account of the IPv4 subnet", + "name": "account", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", + "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": "guest IPv4 subnet", + "name": "subnet", + "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Lists details of network protocols", @@ -50918,9 +51206,10 @@ ], "related": "", "response": [ + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", + "name": "index", "type": "integer" }, { @@ -50928,28 +51217,27 @@ "name": "jobid", "type": "string" }, + { + "description": "the description of the protocol parameter", + "name": "description", + "type": "string" + }, { "description": "the details of the protocol parameter", "name": "details", "type": "map" }, - {}, - {}, { - "description": "the name of the protocol parameter", - "name": "name", - "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 name of the protocol parameter", + "name": "name", "type": "string" }, - { - "description": "the index (ID, Value, Code, Type, Option, etc) of the protocol parameter", - "name": "index", - "type": "integer" - } + {} ], "since": "4.19.0" }, @@ -50958,6 +51246,13 @@ "isasync": false, "name": "listLBHealthCheckPolicies", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -50972,11 +51267,19 @@ "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": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, @@ -50988,53 +51291,33 @@ "required": false, "since": "4.4", "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "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": "createLBHealthCheckPolicy", "response": [ - { - "description": "the account of the HealthCheck policy", - "name": "account", - "type": "string" - }, { "description": "the list of healthcheckpolicies", "name": "healthcheckpolicy", "response": [ { - "description": "Amount of time between health checks", - "name": "healthcheckinterval", - "type": "int" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "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", + "description": "Amount of time between health checks", + "name": "healthcheckinterval", "type": "int" }, { - "description": "the pingpath of the healthcheck policy", - "name": "pingpath", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" }, { "description": "the description of the healthcheck policy", @@ -51042,13 +51325,13 @@ "type": "string" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", + "type": "string" }, { - "description": "Time to wait when receiving a response from the health check", - "name": "responsetime", + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", "type": "int" }, { @@ -51057,44 +51340,49 @@ "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "Number of consecutive health check failures before declaring an instance unhealthy.", + "name": "unhealthcheckthresshold", + "type": "int" } ], "type": "list" }, - {}, - {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "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 domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain of the HealthCheck policy", - "name": "domain", + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", "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" } ], "since": "4.2.0" @@ -51104,22 +51392,6 @@ "isasync": true, "name": "migrateVirtualMachineWithVolume", "params": [ - { - "description": "the ID of the virtual machine", - "length": 255, - "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, - "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>", "length": 255, @@ -51127,6 +51399,14 @@ "required": false, "type": "map" }, + { + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "required": true, + "type": "uuid" + }, { "description": "Automatically select a destination host for a running instance, if hostId is not specified. false by default", "length": 255, @@ -51134,491 +51414,713 @@ "required": false, "since": "4.19.0", "type": "boolean" + }, + { + "description": "Destination Host ID to migrate VM to.", + "length": 255, + "name": "hostid", + "related": "addBaremetalHost,addHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ { - "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": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "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 ID of the affinity group", + "name": "id", + "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 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 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 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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, + {}, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "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": "OS type id of the vm", - "name": "ostypeid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "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 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": "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": "the project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "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 X resolution", - "name": "maxresolutionx", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "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": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "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": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, - {}, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "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 the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the domain name of the security group", + "name": "domain", + "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "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", + "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": "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": "tag key name", + "name": "key", + "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 description of the affinity group", - "name": "description", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", - "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 protocol of the security group rule", + "name": "protocol", + "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 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 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": "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": "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 value", + "name": "value", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "account owning the security group rule", + "name": "account", + "type": "string" + } + ], + "type": "set" }, { - "description": "the account owning the affinity group", - "name": "account", - "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 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 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": "id of the resource", + "name": "resourceid", + "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" + }, + { + "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" + } + ], + "type": "set" + }, + { + "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": "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 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 domain ID of the affinity group", + "description": "the domain ID of the security group", "name": "domainid", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "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 name of the affinity group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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" } ], "type": "set" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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", + "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", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" }, + {}, { - "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": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "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": "the hypervisor on which the template runs", - "name": "hypervisor", - "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "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": "User VM type", + "name": "vmtype", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "description": "Instance lease expiry action", "name": "leaseexpiryaction", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "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", + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "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 VM type", - "name": "vmtype", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - {}, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "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 maximum number of display heads", @@ -51626,33 +52128,18 @@ "type": "long" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "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 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 service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { @@ -51660,13 +52147,13 @@ "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -51675,18 +52162,13 @@ "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { @@ -51695,48 +52177,53 @@ "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "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 name of the corresponding network", - "name": "networkname", + "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": "MTU configured on the NIC", "name": "mtu", "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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" }, { @@ -51745,23 +52232,23 @@ "type": "list" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { @@ -51770,528 +52257,329 @@ "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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 type of the nic", - "name": "type", + "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": "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": "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", + "type": "string" } ], "type": "set" }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, { "description": "the password (if exists) of the virtual machine", "name": "password", "type": "string" }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "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", + "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", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "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 name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "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": "list of security groups associated with the virtual machine", - "name": "securitygroup", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "tag key name", + "name": "key", "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 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": "tag value", + "name": "value", + "type": "string" }, { - "description": "the domain name of the security group", + "description": "the domain associated with the tag", "name": "domain", "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 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", + "description": "id of the resource", + "name": "resourceid", "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 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 project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "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 domain in which the virtual machine exists", - "name": "domainid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, { "description": "the memory allocated for the virtual machine", "name": "memory", "type": "integer" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" } ] @@ -52301,20 +52589,6 @@ "isasync": false, "name": "listGuiThemes", "params": [ - { - "description": "Whether to list all themes.", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, - { - "description": "The internet Common Name (CN) to be filtered.", - "length": 255, - "name": "commonname", - "required": false, - "type": "string" - }, { "description": "Whether to list removed themes.", "length": 255, @@ -52323,26 +52597,26 @@ "type": "boolean" }, { - "description": "The name of the theme.", + "description": "The theme ID.", "length": 255, - "name": "name", + "name": "id", + "related": "listGuiThemes,createGuiTheme", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "Whether to only list the default theme.", "length": 255, - "name": "pagesize", + "name": "listonlydefaulttheme", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "The ID of the account to be filtered.", + "description": "The internet Common Name (CN) to be filtered.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "commonname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "", @@ -52352,16 +52626,16 @@ "type": "integer" }, { - "description": "Whether to only list the default theme.", + "description": "Whether to list public themes.", "length": 255, - "name": "listonlydefaulttheme", + "name": "showpublic", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "The name of the theme.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -52374,41 +52648,50 @@ "type": "uuid" }, { - "description": "The theme ID.", + "description": "The ID of the account to be filtered.", "length": 255, - "name": "id", - "related": "listGuiThemes,createGuiTheme", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, "type": "uuid" }, { - "description": "Whether to list public themes.", + "description": "Whether to list all themes.", "length": 255, - "name": "showpublic", + "name": "listall", "required": false, "type": "boolean" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "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", + "description": "ID of the custom GUI theme.", + "name": "id", "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", + "description": "Name of the GUI theme.", + "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 GUI theme.", - "name": "description", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "jsonconfiguration", "type": "string" }, { @@ -52416,26 +52699,31 @@ "name": "css", "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": "ID of the custom GUI theme.", - "name": "id", + "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": "Name of the GUI theme.", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "When the GUI theme was removed.", - "name": "removed", - "type": "date" + "description": "Whether to consider the subdomains of the informed domain IDs.", + "name": "recursivedomains", + "type": "boolean" }, { "description": "When the GUI theme was created.", @@ -52443,25 +52731,25 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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": "Description of the GUI theme.", + "name": "description", + "type": "string" }, { - "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": "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": "When the GUI theme was removed.", + "name": "removed", + "type": "date" } ], "since": "4.21.0.0" @@ -52479,68 +52767,68 @@ "type": "string" }, { - "description": "Current password that was being used by the user. You must inform the current password when updating the password.", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "currentpassword", + "name": "timezone", "required": false, "type": "string" }, { - "description": "The API key for the user. Must be specified with userSecretKey", + "description": "User uuid", "length": 255, - "name": "userapikey", - "required": false, - "type": "string" + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", + "required": true, + "type": "uuid" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "description": "The secret key for the user. Must be specified with userApiKey", "length": 255, - "name": "timezone", + "name": "usersecretkey", "required": false, "type": "string" }, { - "description": "Determines if Api key access for this user is enabled, disabled or inherits the value from its parent, the owning account", + "description": "first name", "length": 255, - "name": "apikeyaccess", + "name": "firstname", "required": false, - "since": "4.20.1.0", "type": "string" }, { - "description": "first name", + "description": "email", "length": 255, - "name": "firstname", + "name": "email", "required": false, "type": "string" }, { - "description": "User uuid", + "description": "Current password that was being used by the user. You must inform the current password when updating the password.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser,updateUser", - "required": true, - "type": "uuid" + "name": "currentpassword", + "required": false, + "type": "string" }, { - "description": "Unique username", + "description": "The API key for the user. Must be specified with userSecretKey", "length": 255, - "name": "username", + "name": "userapikey", "required": false, "type": "string" }, { - "description": "email", + "description": "Unique username", "length": 255, - "name": "email", + "name": "username", "required": false, "type": "string" }, { - "description": "The secret key for the user. Must be specified with userApiKey", + "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": "usersecretkey", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "type": "string" }, { @@ -52561,35 +52849,20 @@ ], "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", "response": [ - {}, { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the user", - "name": "domain", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, + {}, { - "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": "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 timezone user was created in", - "name": "timezone", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { @@ -52597,21 +52870,26 @@ "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the user state", - "name": "state", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the secret key of the user", - "name": "secretkey", + "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 domain ID of the user", + "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 role", @@ -52619,64 +52897,69 @@ "type": "string" }, { - "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 user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user email address", - "name": "email", + "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 user firstname", + "name": "firstname", + "type": "string" }, { "description": "true if user has two factor authentication enabled", @@ -52684,19 +52967,24 @@ "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": "the name of the role", - "name": "rolename", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user name", + "name": "username", "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" } ] }, @@ -52709,33 +52997,33 @@ "description": "the ID of the load balancer rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "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 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" } ] }, @@ -52745,64 +53033,63 @@ "name": "addHost", "params": [ { - "description": "hypervisor type of the host", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "hypervisor", - "required": true, + "name": "username", + "required": false, "type": "string" }, { - "description": "comma separated list of storage access groups for the host", + "description": "the Pod ID for the host", "length": 255, - "name": "storageaccessgroups", - "required": false, - "since": "4.21.0", - "type": "list" + "name": "podid", + "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { - "description": "the cluster name for the host", + "description": "the host URL", "length": 255, - "name": "clustername", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "hypervisor type of the host", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "the cluster ID for the host", "length": 255, - "name": "podid", - "related": "createPod,listPods,updatePod,createManagementNetworkIpRange", - "required": true, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "the cluster name for the host", "length": 255, - "name": "externaldetails", + "name": "clustername", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "allocationstate", + "name": "password", "required": false, "type": "string" }, { - "description": "the cluster ID for the host", + "description": "comma separated list of storage access groups for the host", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "storageaccessgroups", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "list" }, { "description": "the Zone ID for the host", @@ -52813,149 +53100,157 @@ "type": "uuid" }, { - "description": "the username 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": "username", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "the host URL", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "url", - "required": true, + "name": "allocationstate", + "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "list of tags to be added to the host", "length": 255, - "name": "password", + "name": "hosttags", "required": false, - "type": "string" + "type": "list" } ], - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the name of the host", + "name": "name", "type": "string" }, - {}, { - "description": "the host hypervisor", - "name": "hypervisor", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "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", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, + {}, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the date and time the host was removed", + "name": "removed", "type": "date" }, { - "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": "Total GPUs on the Host", "name": "gputotal", "type": "long" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "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 amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "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": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "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": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "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": "true if the host is disconnected. False otherwise.", @@ -52963,105 +53258,84 @@ "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "The ID of extension for this cluster", + "name": "extensionid", "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": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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 amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" - }, - { - "description": "events available for the host", - "name": "events", - "type": "string" - }, - { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "the Zone ID of the host", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { "description": "the date and time the host was created", @@ -53069,23 +53343,13 @@ "type": "date" }, { - "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", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the name of the host", - "name": "name", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { @@ -53094,102 +53358,91 @@ "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the host version", - "name": "version", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "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", + "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", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", - "type": "string" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { "description": "capabilities of the host", "name": "capabilities", "type": "string" }, - { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" - }, { "description": "the host out-of-band management information", "name": "outofbandmanagement", "type": "outofbandmanagementresponse" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, - {}, { "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": "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", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "description": "Maximum Y resolution per display", + "name": "maxresolutiony", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum displays per user", + "name": "maxheads", "type": "long" }, { @@ -53198,8 +53451,8 @@ "type": "string" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -53208,74 +53461,109 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "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" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, + { + "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 cluster", + "name": "clusterstorageaccessgroups", + "type": "string" + }, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "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": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", "name": "cpuwithoverprovisioning", "type": "string" }, + { + "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 cluster ID of the host", - "name": "clusterid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "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 CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "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 outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the host version", + "name": "version", + "type": "string" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", "type": "string" } ] @@ -53296,7 +53584,7 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" }, @@ -53311,55 +53599,29 @@ ], "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "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": "size of the disk volume", "name": "size", "type": "long" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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": "shared or local storage", + "name": "storagetype", "type": "string" }, - {}, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -53368,29 +53630,29 @@ "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", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", - "type": "string" + "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", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" }, { "description": "the format of the disk encryption if applicable", @@ -53398,28 +53660,29 @@ "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "id of the virtual machine", + "name": "virtualmachineid", "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { @@ -53428,43 +53691,48 @@ "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", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { @@ -53473,32 +53741,62 @@ "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "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": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ - { - "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", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -53507,28 +53805,28 @@ "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": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { @@ -53537,56 +53835,57 @@ "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", "type": "string" } ], "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "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": "name of the virtual machine", - "name": "vmname", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, + {}, { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { @@ -53595,40 +53894,39 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, - {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the status of the volume", + "name": "status", + "type": "string" }, { - "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": "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": "the current status of the latest async job acting on this object", @@ -53636,103 +53934,93 @@ "type": "integer" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "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": "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" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "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 primary storage hosting the disk volume", - "name": "storage", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "pod id of the volume", - "name": "podid", - "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" } ] @@ -53742,21 +54030,6 @@ "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": "an optional account for the userdata. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the ID of the Userdata", "length": 255, @@ -53772,15 +54045,30 @@ "related": "activateProject,createProject,suspendProject,updateProject", "required": false, "type": "uuid" + }, + { + "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": "an optional account for the userdata. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "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", @@ -53791,12 +54079,12 @@ "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.21.0" }, @@ -53806,11 +54094,11 @@ "name": "updateProject", "params": [ { - "description": "id of the project to be modified", + "description": "ID of the user to be promoted/demoted", "length": 255, - "name": "id", - "related": "activateProject,createProject,suspendProject,updateProject", - "required": true, + "name": "userid", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": false, "type": "uuid" }, { @@ -53822,17 +54110,16 @@ "type": "string" }, { - "description": "ID of the user to be promoted/demoted", + "description": "Account level role to be assigned to the user/account : Admin/Regular", "length": 255, - "name": "userid", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "name": "roletype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Account level role to be assigned to the user/account : Admin/Regular", + "description": "new Admin account for the project", "length": 255, - "name": "roletype", + "name": "account", "required": false, "type": "string" }, @@ -53844,11 +54131,12 @@ "type": "string" }, { - "description": "new Admin account for the project", + "description": "id of the project to be modified", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "id", + "related": "activateProject,createProject,suspendProject,updateProject", + "required": true, + "type": "uuid" }, { "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", @@ -53861,120 +54149,68 @@ "related": "activateProject,createProject,suspendProject", "response": [ { - "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" - } - ], + "description": "the account name of the project's owners", + "name": "owner", "type": "list" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the state of the project", + "name": "state", "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "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) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { @@ -53983,261 +54219,313 @@ "type": "integer" }, { - "description": "the total number of networks owned by project", - "name": "networktotal", - "type": "long" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, + {}, { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "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) the project can own", - "name": "primarystoragelimit", + "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", + "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", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", + "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 state of the project", - "name": "state", + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", - "type": "long" + "description": "the total number of gpus the project can own", + "name": "gpulimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" + "description": "the list of resource tags associated with vm", + "name": "tags", + "response": [ + { + "description": "the project name where tag belongs to", + "name": "project", + "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 id the tag belongs to", + "name": "projectid", + "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": "the domain associated with the tag", + "name": "domain", + "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" + } + ], + "type": "list" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, { "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 networks the project can own", + "name": "networklimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", - "type": "string" + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total memory (in MB) available to be created for this project", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of vpcs the project can own", - "name": "vpclimit", + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", "type": "string" }, { - "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 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 number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", - "type": "string" + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" }, + {}, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "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 deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the project account name of the project", - "name": "projectaccountname", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "type": "long" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the total number of vpcs available to be created for this project", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "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 name of the project", + "name": "name", + "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) the project can own", + "name": "backupstoragelimit", "type": "string" }, - {}, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "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) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "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" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total primary storage space (in GiB) available to be used for this project", + "name": "primarystorageavailable", "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 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" } ], "since": "3.0.0" @@ -54248,70 +54536,70 @@ "name": "listLoadBalancers", "params": [ { - "description": "the ID of the load balancer", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the source IP address of the load balancer", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "sourceipaddress", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "the scheme of the load balancer. Supported value is internal in the current release", + "description": "the source IP address of the load balancer", "length": 255, - "name": "scheme", + "name": "sourceipaddress", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "the network ID of the load balancer", "length": 255, - "name": "keyword", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "activateProject,createProject,suspendProject", "required": false, - "type": "map" + "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": "the network ID of the source IP address", + "description": "the scheme of the load balancer. Supported value is internal in the current release", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "scheme", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the name of the load balancer", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "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 display flag; only ROOT admin is eligible to pass this parameter", @@ -54322,86 +54610,60 @@ "type": "boolean" }, { - "description": "the network ID of the load balancer", + "description": "List by keyword", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "name": "keyword", "required": false, - "type": "uuid" + "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": "pagesize", + "name": "isrecursive", "required": false, - "type": "integer" + "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": "the ID of the load balancer", "length": 255, - "name": "listall", + "name": "id", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", + "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 network ID of the source IP address", "length": 255, - "name": "isrecursive", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listNetscalerLoadBalancerNetworks,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "required": false, - "type": "boolean" + "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" } ], "related": "createLoadBalancer", "response": [ - { - "description": "Load Balancer network id", - "name": "networkid", - "type": "string" - }, - { - "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", + "description": "the domain of the Load Balancer", + "name": "domain", "type": "string" }, { @@ -54409,76 +54671,136 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { - "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": "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" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, + { + "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": "the name of the Load Balancer", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, {}, + { + "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 load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", + "type": "string" + }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "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": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the list of instances associated with the Load Balancer", "name": "loadbalancerinstance", "response": [ { - "description": "the state of the instance", - "name": "state", + "description": "the instance ID", + "name": "id", "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the state of the instance", + "name": "state", "type": "string" }, { @@ -54495,25 +54817,11 @@ "type": "list" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain of the Load Balancer", - "name": "domain", - "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 Load Balancer belongs", - "name": "domainpath", + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", "type": "string" }, + {}, { "description": "the list of rules associated with the Load Balancer", "name": "loadbalancerrule", @@ -54536,30 +54844,10 @@ ], "type": "list" }, - { - "description": "the description of the Load Balancer", - "name": "description", - "type": "string" - }, - { - "description": "the account of the Load Balancer", - "name": "account", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Load Balancer ID", "name": "id", "type": "string" - }, - { - "description": "the project name of the Load Balancer", - "name": "project", - "type": "string" } ], "since": "4.2.0" @@ -54580,16 +54868,6 @@ ], "related": "getUserKeys", "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 UUID of the latest async job acting on this object", "name": "jobid", @@ -54601,12 +54879,22 @@ "name": "apikeyaccess", "type": "boolean" }, + { + "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" - }, - {} + } ] }, { @@ -54624,28 +54912,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" + } ], "since": "3.0.0" }, @@ -54655,230 +54943,230 @@ "name": "listVpnConnections", "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": "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": "id of vpc", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "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" }, { - "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": "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": "activateProject,createProject,suspendProject", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 vpn connection", + "description": "id of vpc", "length": 255, - "name": "id", - "related": "createVpnConnection,listVpnConnections,updateVpnConnection", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "id of the vpn connection", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createVpnConnection,listVpnConnections,updateVpnConnection", "required": false, - "type": "boolean" + "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": "", + "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" } ], "related": "createVpnConnection,updateVpnConnection", "response": [ { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", + "name": "splitconnections", + "type": "boolean" + }, + { + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "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", "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the public IP address", + "name": "publicip", "type": "string" }, - {}, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the domain name of the owner", + "name": "domain", + "type": "string" }, + {}, { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "the owner", + "name": "account", "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": "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": "IKE policy of the customer gateway", - "name": "ikepolicy", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { "description": "the connection ID", "name": "id", "type": "string" }, - { - "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": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the domain path of the owner", + "name": "domainpath", "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", + "description": "is connection for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, + {}, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, - { - "description": "State of vpn connection", - "name": "state", + "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": "State of vpn connection", - "name": "passive", - "type": "boolean" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "the project name", - "name": "project", + "description": "State of vpn connection", + "name": "state", "type": "string" }, - {}, { - "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 owner", - "name": "account", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" } ] @@ -54888,6 +55176,13 @@ "isasync": true, "name": "removeTungstenFabricPolicy", "params": [ + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, { "description": "the uuid of Tungsten-Fabric network", "length": 255, @@ -54902,17 +55197,25 @@ "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", "response": [ + { + "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 name", "name": "zonename", @@ -54920,17 +55223,12 @@ }, {}, {}, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, - { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -54940,16 +55238,6 @@ "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 policy name", - "name": "name", - "type": "string" } ] }, @@ -54973,61 +55261,46 @@ "type": "string" }, { - "description": "the name for the image store", + "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": "name", + "name": "details", "required": false, - "type": "string" + "type": "map" }, { - "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 name for the image store", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,addImageStoreS3,listImageStores", "response": [ { - "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 Zone ID of the image store", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the provider name of the image store", + "name": "providername", + "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, - { - "description": "the provider name of the image store", - "name": "providername", - "type": "string" - }, - { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the Zone name of the image store", + "name": "zonename", "type": "string" }, { @@ -55035,31 +55308,46 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "the url of the image store", - "name": "url", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" + }, + { + "description": "defines if store is read-only", + "name": "readonly", "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the name of the image store", + "name": "name", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", - "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 image store", - "name": "zonename", + "description": "the url of the image store", + "name": "url", "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "the host's currently used disk size", + "name": "disksizeused", + "type": "long" } ], "since": "4.3.0" @@ -55069,14 +55357,6 @@ "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, @@ -55090,32 +55370,23 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Created date", - "name": "created", - "type": "date" - }, - {}, { "description": "End AS Number", "name": "endasn", "type": "long" }, - {}, - { - "description": "Start AS Number", - "name": "startasn", - "type": "long" - }, { "description": "ID of the AS Number Range", "name": "id", @@ -55130,7 +55401,24 @@ "description": "Zone ID", "name": "zoneid", "type": "string" - } + }, + { + "description": "Start AS Number", + "name": "startasn", + "type": "long" + }, + { + "description": "Created date", + "name": "created", + "type": "date" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {} ], "since": "4.20.0" }, @@ -55165,30 +55453,30 @@ "related": "createTungstenFabricLogicalRouter,removeTungstenFabricNetworkGatewayFromLogicalRouter,listTungstenFabricLogicalRouter", "response": [ { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, + {}, { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "Tungsten-Fabric logical router name", "name": "name", "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": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", "type": "string" }, { @@ -55197,9 +55485,9 @@ "type": "integer" }, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -55216,16 +55504,16 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric nic", "length": 255, - "name": "keyword", + "name": "nicuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric nic", + "description": "List by keyword", "length": 255, - "name": "nicuuid", + "name": "keyword", "required": false, "type": "string" }, @@ -55247,12 +55535,12 @@ ], "related": "", "response": [ + {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, { "description": "Tungsten-Fabric nic uuid", "name": "uuid", @@ -55263,17 +55551,17 @@ "name": "zoneid", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric nic name", + "name": "name", "type": "string" }, { - "description": "Tungsten-Fabric nic name", - "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", @@ -55286,13 +55574,6 @@ "isasync": false, "name": "listVmwareDcs", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "Id of the CloudStack zone.", "length": 255, @@ -55304,52 +55585,59 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } ], "related": "addVmwareDc", "response": [ - {}, - {}, { - "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", + "description": "The VMware vCenter name/ip", + "name": "vcenter", "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 VMware vCenter name/ip", - "name": "vcenter", + "description": "The VMware Datacenter name", + "name": "name", "type": "string" }, { - "description": "the Zone ID associated with this VMware Datacenter", - "name": "zoneid", - "type": "long" + "description": "The VMware Datacenter ID", + "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" + }, + {} ] }, { @@ -55357,6 +55645,14 @@ "isasync": true, "name": "applyTungstenFabricPolicy", "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "createZone,listZones,listZones", + "required": true, + "type": "uuid" + }, { "description": "the uuid of network", "length": 255, @@ -55364,6 +55660,13 @@ "required": true, "type": "string" }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": true, + "type": "string" + }, { "description": "the major sequence of Tungsten-Fabric policy", "length": 255, @@ -55377,63 +55680,48 @@ "name": "minorsequence", "required": true, "type": "integer" - }, - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "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", "response": [ { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, - {}, - {}, - {}, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy name", + "name": "name", "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 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", + "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" - } + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ] }, { @@ -55441,6 +55729,13 @@ "isasync": false, "name": "listZones", "params": [ + { + "description": "the network type of the zone that the virtual machine belongs to", + "length": 255, + "name": "networktype", + "required": false, + "type": "string" + }, { "description": "flag to display the resource image for the zones", "length": 255, @@ -55449,11 +55744,11 @@ "type": "boolean" }, { - "description": "flag to display the capacity of the zones", + "description": "List by keyword", "length": 255, - "name": "showcapacities", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "the ID of the zone", @@ -55464,33 +55759,20 @@ "type": "uuid" }, { - "description": "the network type of the zone that the virtual machine belongs to", - "length": 255, - "name": "networktype", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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.", + "description": "", "length": 255, - "name": "available", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "the ID of the domain associated with the zone", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "ids", + "related": "createZone,listZones,listZones", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "list" }, { "description": "List zones by resource tags (key/value pairs)", @@ -55507,6 +55789,14 @@ "required": false, "type": "integer" }, + { + "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": "the name of the storage access group", "length": 255, @@ -55516,20 +55806,18 @@ "type": "string" }, { - "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": "", + "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": "page", + "name": "available", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the name of the zone", @@ -55542,54 +55830,125 @@ "related": "createZone,listZones", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Zone name", + "name": "name", + "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 private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" + "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 second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", "type": "boolean" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "description": "External network provider if any", + "name": "provider", + "type": "string" }, { - "description": "the first DNS for the Zone", - "name": "dns1", - "type": "string" + "description": "the capacity of the Zone", + "name": "capacity", + "response": [ + { + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the capacity name", + "name": "name", + "type": "string" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", + "type": "string" + }, + { + "description": "the Cluster name", + "name": "clustername", + "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 type", + "name": "type", + "type": "short" + }, + { + "description": "the Pod ID", + "name": "podid", + "type": "string" + }, + { + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + } + ], + "type": "list" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "the name of the containing domain, null for public zones", + "name": "domainname", "type": "string" }, { @@ -55598,25 +55957,24 @@ "type": "long" }, { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" + "description": "Zone Token", + "name": "zonetoken", + "type": "string" }, - {}, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the zone - core or edge", - "name": "type", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" + "description": "AS Number Range", + "name": "asnrange", + "type": "string" }, { "description": "Network domain name for the networks in the zone", @@ -55624,44 +55982,35 @@ "type": "string" }, { - "description": "true, if routed network/vpc is enabled", - "name": "routedmodeenabled", - "type": "boolean" - }, - { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, - { - "description": "the display text of the zone", - "name": "displaytext", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", - "type": "string" + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" }, + {}, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "Zone name", - "name": "name", - "type": "string" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "the first internal DNS for the Zone", + "name": "internaldns1", "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 list of resource tags associated with zone.", @@ -55672,6 +56021,16 @@ "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": "customer associated with the tag", "name": "customer", @@ -55683,23 +56042,23 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { @@ -55711,43 +56070,49 @@ "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 network type of the zone; can be Basic or Advanced", - "name": "networktype", - "type": "string" + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", + "type": "boolean" }, + {}, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" + }, + { + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Zone description", - "name": "description", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "External network provider if any", - "name": "provider", + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -55756,8 +56121,8 @@ "type": "string" }, { - "description": "Zone id", - "name": "id", + "description": "the display text of the zone", + "name": "displaytext", "type": "string" }, { @@ -55766,101 +56131,24 @@ "type": "string" }, { - "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", - "name": "ismultiarch", - "type": "boolean" - }, - { - "description": "the first internal DNS for the Zone", - "name": "internaldns1", + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", "type": "string" }, { - "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 capacity of the Zone", - "name": "capacity", - "response": [ - { - "description": "the Cluster name", - "name": "clustername", - "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 capacity name", - "name": "name", - "type": "string" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" - }, - { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" - }, - { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", - "type": "string" - }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", - "type": "string" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - } - ], - "type": "list" + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", - "type": "string" + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", + "type": "boolean" } ] }, @@ -55877,27 +56165,32 @@ "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.", + "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": "id", - "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", + "name": "ipaddress", "required": false, - "type": "uuid" + "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.", + "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, - "name": "ipaddress", + "name": "id", + "related": "listQuarantinedIps,updateQuarantinedIp,removeQuarantinedIp", "required": false, - "type": "string" + "type": "uuid" } ], "related": "listQuarantinedIps,updateQuarantinedIp", "response": [ { - "description": "ID of the account that removed the IP from quarantine.", - "name": "removeraccountid", - "type": "string" + "description": "When the quarantine was created.", + "name": "created", + "type": "date" + }, + { + "description": "When the quarantine was removed.", + "name": "removed", + "type": "date" }, { "description": "ID of the quarantine process.", @@ -55905,51 +56198,46 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the account that removed the IP from quarantine.", + "name": "removeraccountid", "type": "string" }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, + {}, + {}, { "description": "End date for the quarantine.", "name": "enddate", "type": "date" }, { - "description": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { - "description": "When the quarantine 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 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 created.", - "name": "created", - "type": "date" - }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" } ], "since": "4.19" @@ -55966,13 +56254,6 @@ "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, @@ -55980,13 +56261,6 @@ "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, @@ -56001,67 +56275,96 @@ "required": false, "type": "map" }, + { + "description": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", + "length": 255, + "name": "orchestratorrequirespreparevm", + "required": false, + "type": "boolean" + }, { "description": "Description of the extension", "length": 255, "name": "description", "required": false, "type": "string" + }, + { + "description": "Name of the extension", + "length": 255, + "name": "name", + "required": true, + "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": "Description of the extension", + "name": "description", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - {}, { "description": "Name of the extension", "name": "name", "type": "string" }, + {}, { - "description": "ID of the extension", - "name": "id", + "description": "The state of the extension", + "name": "state", "type": "string" }, { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "True if the extension is added by admin", + "name": "isuserdefined", "type": "boolean" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, { "description": "List of resources to which extension is registered to", "name": "resources", "response": [ { - "description": "Creation timestamp of the mapping", - "name": "created", - "type": "date" + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" }, { "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", @@ -56071,45 +56374,30 @@ "description": "the details of the resource map", "name": "details", "type": "map" + }, + { + "description": "Creation timestamp of the mapping", + "name": "created", + "type": "date" } ], "type": "list" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" - }, - { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "ID of the extension", + "name": "id", "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", - "type": "string" - }, - { - "description": "The state of the extension", - "name": "state", - "type": "string" - }, - { - "description": "Type of the extension", - "name": "type", - "type": "string" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" }, { - "description": "Description of the extension", - "name": "description", - "type": "string" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" } ], "since": "4.21.0" @@ -56123,7 +56411,7 @@ "description": "ID of the VM from which all backup schedules will be deleted.", "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": false, "type": "uuid" }, @@ -56138,27 +56426,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": "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.14.0" @@ -56169,18 +56457,18 @@ "name": "listBackupProviderOfferings", "params": [ { - "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": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "The zone ID", @@ -56200,11 +56488,6 @@ ], "related": "importBackupOffering,listBackupOfferings,updateBackupOffering", "response": [ - { - "description": "whether offering allows user driven ad-hoc/scheduled backups", - "name": "allowuserdrivenbackups", - "type": "boolean" - }, { "description": "name for the backup offering", "name": "name", @@ -56215,46 +56498,56 @@ "name": "zonename", "type": "string" }, + {}, + {}, { "description": "external ID on the provider side", "name": "externalid", "type": "string" }, { - "description": "ID of the backup offering", - "name": "id", + "description": "the date this backup offering was created", + "name": "created", + "type": "date" + }, + { + "description": "description for the backup offering", + "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" + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + { + "description": "whether offering allows user driven ad-hoc/scheduled backups", + "name": "allowuserdrivenbackups", + "type": "boolean" }, { "description": "provider name", "name": "provider", "type": "string" }, - { - "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", + "description": "ID of the backup offering", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -56276,24 +56569,24 @@ ], "response": [ { - "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" }, - {}, { "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" }, {} @@ -56307,17 +56600,16 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "netscaler load balancer device ID", + "description": "", "length": 255, - "name": "lbdeviceid", - "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" }, { "description": "List by keyword", @@ -56327,53 +56619,64 @@ "type": "string" }, { - "description": "", + "description": "netscaler load balancer device ID", "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", + "required": true, + "type": "uuid" } ], "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the network's netmask", + "name": "netmask", "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 second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the id of the network", + "name": "id", "type": "string" }, { @@ -56381,53 +56684,124 @@ "name": "sentbytes", "type": "long" }, + {}, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the network domain", + "name": "networkdomain", "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": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { "description": "list networks available for vm deployment", "name": "canusefordeploy", "type": "boolean" }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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", + "type": "string" + }, + { + "description": "The external id of the network", + "name": "externalid", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "the type of the network", + "name": "type", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "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": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "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": "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 routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, { "description": "the list of resource tags associated with network", "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -56441,13 +56815,13 @@ "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -56456,66 +56830,111 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 key name", + "name": "key", "type": "string" } ], "type": "list" }, { - "description": "The external id of the network", - "name": "externalid", + "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": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the type of the network", - "name": "type", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "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 second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", - "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", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { @@ -56524,209 +56943,98 @@ "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "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": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "state of the network", + "name": "state", + "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "description": "the service name", - "name": "name", - "type": "string" - }, - { - "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 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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "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" - } - ], - "type": "list" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, - { - "description": "the owner of the network", - "name": "account", - "type": "string" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, { "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": "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": "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", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" - }, - { - "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": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "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": "the id of the network", - "name": "id", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -56735,130 +57043,115 @@ "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 network's netmask", - "name": "netmask", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the owner of the network", + "name": "account", "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 internet protocol of network offering", "name": "internetprotocol", "type": "string" }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - {}, - {}, - { - "description": "the name of the zone the network belongs to", - "name": "zonename", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" - }, - { - "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 network domain", - "name": "networkdomain", - "type": "string" + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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" + }, + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "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 physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "state of the network", - "name": "state", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" } ] @@ -56878,11 +57171,7 @@ } ], "response": [ - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -56893,13 +57182,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" - }, - {}, - {} + } ] }, { @@ -56910,14 +57203,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -56931,11 +57224,7 @@ ], "related": "", "response": [ - { - "description": "Network isolation method name", - "name": "name", - "type": "string" - }, + {}, {}, { "description": "the UUID of the latest async job acting on this object", @@ -56947,7 +57236,11 @@ "name": "jobstatus", "type": "integer" }, - {} + { + "description": "Network isolation method name", + "name": "name", + "type": "string" + } ], "since": "4.2.0" }, @@ -56960,18 +57253,14 @@ "description": "List by host ID", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" } ], "related": "configureHAForHost,enableHAForHost,disableHAForHost,listHostHAProviders", "response": [ - { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, + {}, { "description": "if host HA is enabled for the host", "name": "haenable", @@ -56982,11 +57271,6 @@ "name": "hastate", "type": "hastate" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the host HA provider", "name": "haprovider", @@ -56997,13 +57281,22 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { "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" + }, + {} ], "since": "4.11" }, @@ -57013,18 +57306,18 @@ "name": "listTungstenFabricFirewallPolicy", "params": [ { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of Tungsten-Fabric firewall policy", "length": 255, - "name": "applicationpolicysetuuid", + "name": "firewallpolicyuuid", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -57033,13 +57326,6 @@ "required": false, "type": "integer" }, - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -57049,32 +57335,27 @@ "type": "uuid" }, { - "description": "", + "description": "the uuid of Tungsten-Fabric application policy set", "length": 255, - "name": "page", + "name": "applicationpolicysetuuid", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "createTungstenFabricFirewallPolicy", "response": [ { - "description": "Tungsten-Fabric firewall policy uuid", - "name": "uuid", + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", @@ -57086,15 +57367,27 @@ "type": "list" }, { - "description": "Tungsten-Fabric firewall policy name", - "name": "name", + "description": "Tungsten-Fabric firewall policy uuid", + "name": "uuid", "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": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric firewall policy name", + "name": "name", "type": "string" - } + }, + {} ] }, { @@ -57103,12 +57396,11 @@ "name": "importBackupOffering", "params": [ { - "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" }, { "description": "Whether users are allowed to create adhoc backups and backup schedules", @@ -57118,29 +57410,45 @@ "type": "boolean" }, { - "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 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": "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" } ], "related": "listBackupOfferings,updateBackupOffering", "response": [ + { + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "description for the backup offering", + "name": "description", + "type": "string" + }, { "description": "name for the backup offering", "name": "name", @@ -57152,35 +57460,29 @@ "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 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": "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", - "type": "date" - }, { - "description": "zone name", - "name": "zonename", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, { @@ -57188,14 +57490,10 @@ "name": "provider", "type": "string" }, + {}, { - "description": "description for the backup offering", - "name": "description", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name", + "name": "zonename", "type": "string" } ], @@ -57223,6 +57521,8 @@ } ], "response": [ + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -57238,13 +57538,11 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ] }, { @@ -57267,14 +57565,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ID of the volume", - "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" - }, { "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, @@ -57282,59 +57572,37 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "the ID of the volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,migrateVolume,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" } ], "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "ID of the disk volume", - "name": "id", - "type": "string" - }, - { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", - "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 service offering for root disk", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "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", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { @@ -57343,33 +57611,38 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "shared or local storage", - "name": "storagetype", + "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" }, { @@ -57378,39 +57651,24 @@ "type": "boolean" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", "type": "map" }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" - }, - { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "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", - "type": "string" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -57418,33 +57676,8 @@ "type": "integer" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", - "type": "string" - }, - { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { @@ -57452,438 +57685,418 @@ "name": "type", "type": "string" }, - { - "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", - "type": "string" - }, - { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" - }, - { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - {}, { "description": "cluster name where the volume is allocated", "name": "clustername", "type": "string" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "cluster id of the volume", + "name": "clusterid", "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": "the path of the volume", - "name": "path", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, + {}, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "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", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "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": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "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": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "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": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, { "description": "pod name of the volume", "name": "podname", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" - }, - { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the virtual machine", + "name": "vmname", "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": "max iops of the disk volume", - "name": "maxiops", + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "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", + "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": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "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": "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": "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" - } - ], - "since": "3.0.0" - }, - { - "description": "create Tungsten-Fabric application policy set", - "isasync": true, - "name": "createTungstenFabricApplicationPolicySet", - "params": [ - { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "createZone,listZones", - "required": true, - "type": "uuid" }, { - "description": "Tungsten-Fabric application policy set name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - } - ], - "related": "", - "response": [ - { - "description": "Tungsten-Fabric application policy uuid", - "name": "uuid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "size of the disk volume", + "name": "size", "type": "long" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "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": "list Tungsten-Fabric firewall policy", - "name": "firewallpolicy", - "type": "list" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "list Tungsten-Fabric tag", - "name": "tag", - "type": "list" + "description": "the path of the volume", + "name": "path", + "type": "string" }, { - "description": "Tungsten-Fabric policy name", - "name": "name", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "the account associated with the disk volume", + "name": "account", "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": "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": "the domain associated with the disk volume", + "name": "domain", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the availability zone", + "name": "zonename", "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 state of the disk volume", + "name": "state", + "type": "string" + }, + { + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" + }, + { + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" + }, + { + "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": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "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 boolean state of whether the volume is destroyed or not", + "name": "destroyed", + "type": "boolean" + }, + { + "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" + } ], - "since": "4.20.0" + "since": "3.0.0" }, { - "description": "A command to list events.", - "isasync": false, - "name": "listEvents", + "description": "create Tungsten-Fabric application policy set", + "isasync": true, + "name": "createTungstenFabricApplicationPolicySet", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "the ID of zone", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", - "required": false, + "name": "zoneid", + "related": "createZone,listZones", + "required": true, "type": "uuid" }, { - "description": "true to list archived events otherwise false", + "description": "Tungsten-Fabric application policy set name", "length": 255, - "name": "archived", - "required": false, - "since": "4.19.0", - "type": "boolean" + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + {}, + { + "description": "Tungsten-Fabric policy name", + "name": "name", + "type": "string" }, { - "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": "startdate", - "required": false, - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the ID of the resource associated with the event", - "length": 255, - "name": "resourceid", - "required": false, - "since": "4.17.0", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "list Tungsten-Fabric firewall policy", + "name": "firewallpolicy", + "type": "list" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "the event level (INFO, WARN, ERROR)", - "length": 255, - "name": "level", - "required": false, + "description": "list Tungsten-Fabric tag", + "name": "tag", + "type": "list" + }, + { + "description": "Tungsten-Fabric application policy uuid", + "name": "uuid", "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" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {} + ] + }, + { + "description": "A command to list events.", + "isasync": false, + "name": "listEvents", + "params": [ { - "description": "List by keyword", + "description": "the type of the resource associated with the event", "length": 255, - "name": "keyword", + "name": "resourcetype", "required": false, + "since": "4.17.0", "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": "the time the event was entered", @@ -57892,27 +58105,20 @@ "required": false, "type": "integer" }, - { - "description": "the event type (see event types)", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the type of the resource associated with the event", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "resourcetype", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "since": "4.17.0", - "type": "string" + "type": "uuid" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -57921,6 +58127,14 @@ "required": false, "type": "boolean" }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "activateProject,createProject,suspendProject", + "required": false, + "type": "uuid" + }, { "description": "The state of the events", "length": 255, @@ -57929,6 +58143,13 @@ "since": "4.21.0", "type": "string" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "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, @@ -57938,27 +58159,50 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the ID of the event", "length": 255, - "name": "account", + "name": "id", + "related": "listEvents", + "required": false, + "type": "uuid" + }, + { + "description": "the event type (see event types)", + "length": 255, + "name": "type", "required": false, "type": "string" }, { - "description": "the ID of the event", + "description": "the duration of the event", "length": 255, - "name": "id", - "related": "listEvents", + "name": "duration", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "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": "enddate", + "name": "startdate", "required": false, "type": "date" }, + { + "description": "true to list archived events otherwise false", + "length": 255, + "name": "archived", + "required": false, + "since": "4.19.0", + "type": "boolean" + }, + { + "description": "the ID of the resource associated with the event", + "length": 255, + "name": "resourceid", + "required": false, + "since": "4.17.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.", "length": 255, @@ -57967,49 +58211,68 @@ "type": "boolean" }, { - "description": "the duration of the event", + "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": "duration", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the event level (INFO, WARN, ERROR)", + "length": 255, + "name": "level", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "the type of the event (see event types)", - "name": "type", + "description": "the name of the resource", + "name": "resourcename", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the date the event was created", + "name": "created", + "type": "date" + }, + { + "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", + "name": "account", "type": "string" }, { - "description": "the type of the resource", - "name": "resourcetype", + "description": "the name of the account's domain", + "name": "domain", "type": "string" }, { - "description": "whether the event is parented", - "name": "parentid", + "description": "the ID of the event", + "name": "id", "type": "string" }, {}, { - "description": "the name of the account's domain", - "name": "domain", - "type": "string" + "description": "the state of the event", + "name": "state", + "type": "state" }, { - "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 event level (INFO, WARN, ERROR)", - "name": "level", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -58018,18 +58281,13 @@ "type": "string" }, { - "description": "path of the Domain the account's domain belongs to", - "name": "domainpath", + "description": "the event level (INFO, WARN, ERROR)", + "name": "level", "type": "string" }, { - "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)", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -58038,48 +58296,88 @@ "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 ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the id of the account's domain", - "name": "domainid", + "description": "path of the Domain the account's domain belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "whether the event is parented", + "name": "parentid", "type": "string" }, { - "description": "the account name for the account that owns the object being acted on in the event (e.g. the owner of the virtual machine, ip address, or security group)", - "name": "account", + "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)", + "name": "username", "type": "string" }, { - "description": "the ID of the event", - "name": "id", - "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 event (see event types)", + "name": "type", "type": "string" }, { - "description": "the state of the event", - "name": "state", - "type": "state" + "description": "the type of the resource", + "name": "resourcetype", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the id of the account's domain", + "name": "domainid", "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": "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" + }, + {}, + {} + ], + "since": "4.20.0" + }, { "description": "Lists HA providers", "isasync": false, @@ -58096,41 +58394,41 @@ "related": "configureHAForHost,enableHAForHost,disableHAForHost", "response": [ { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, {}, { - "description": "operation status", - "name": "status", + "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", + "type": "string" + }, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "if host HA is enabled for the host", - "name": "haenable", + "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 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" @@ -58141,17 +58439,17 @@ "name": "createTags", "params": [ { - "description": "type of the resource", + "description": "Map of tags (key/value pairs)", "length": 255, - "name": "resourcetype", + "name": "tags", "required": true, - "type": "string" + "type": "map" }, { - "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", + "description": "type of the resource", "length": 255, - "name": "customer", - "required": false, + "name": "resourcetype", + "required": true, "type": "string" }, { @@ -58162,11 +58460,11 @@ "type": "list" }, { - "description": "Map of tags (key/value pairs)", + "description": "identifies client specific tag. When the value is not null, the tag can't be used by cloudStack code internally", "length": 255, - "name": "tags", - "required": true, - "type": "map" + "name": "customer", + "required": false, + "type": "string" } ], "response": [ @@ -58175,23 +58473,23 @@ "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": "any text associated with the success or failure", "name": "displaytext", "type": "string" - }, - {} + } ], "since": "4.0.0" }, @@ -58211,33 +58509,33 @@ ], "related": "configureInternalLoadBalancerElement,listInternalLoadBalancerElements", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, {}, { "description": "the id of the internal load balancer element", "name": "id", "type": "string" }, + { + "description": "the physical network service provider id of the element", + "name": "nspid", + "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": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" - }, - { - "description": "the physical network service provider id of the element", - "name": "nspid", - "type": "string" - }, - {} + } ], "since": "4.2.0" }, @@ -58261,23 +58559,23 @@ "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" - }, - {} + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -58295,16 +58593,10 @@ } ], "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", @@ -58313,10 +58605,16 @@ }, {}, { - "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" + }, + {} ] }, { @@ -58331,6 +58629,13 @@ "required": true, "type": "short" }, + { + "description": "Alert description", + "length": 999, + "name": "description", + "required": true, + "type": "string" + }, { "description": "Zone id for which alert is generated", "length": 255, @@ -58353,28 +58658,15 @@ "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": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -58384,6 +58676,12 @@ "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.3" @@ -58394,125 +58692,125 @@ "name": "ldapConfig", "params": [ { - "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", "length": 255, - "name": "searchbase", + "name": "hostname", "required": false, "type": "string" }, { - "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": "If true return current LDAP configuration", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain.", "length": 255, - "name": "listall", + "name": "queryfilter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "description": "Enter the password for trust store.", "length": 255, - "name": "hostname", + "name": "truststorepass", "required": false, "type": "string" }, { - "description": "Enter the password.", + "description": "The search base defines the starting point for the search in the directory tree Example: dc=cloud,dc=com.", "length": 255, - "name": "bindpass", + "name": "searchbase", "required": false, "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", + "description": "If true return current LDAP configuration", "length": 255, - "name": "ssl", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "Enter the path to trust certificates store.", + "description": "Specify the LDAP port if required, default is 389.", "length": 255, - "name": "truststore", + "name": "port", "required": false, - "type": "string" + "type": "integer" }, { - "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": "Specify the LDAP port if required, default is 389.", + "description": "Specify the distinguished name of a user with the search permission on the directory.", "length": 255, - "name": "port", + "name": "binddn", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Enter the password for trust store.", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL.", "length": 255, - "name": "truststorepass", + "name": "ssl", "required": false, - "type": "string" + "type": "boolean" } ], "related": "ldapRemove", "response": [ { - "description": "Specify the distinguished name of a user with the search permission on the directory", - "name": "binddn", + "description": "DN password", + "name": "bindpass", "type": "string" }, - {}, { - "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" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", + "type": "string" }, - {}, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "Hostname or ip address of the ldap server eg: my.ldap.com", + "name": "hostname", "type": "string" }, { - "description": "Specify the LDAP port if required, default is 389", - "name": "port", + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", "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.0" }, @@ -58532,26 +58830,21 @@ ], "related": "", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, {}, {}, - { - "description": "the name of the Storage Policy", - "name": "name", - "type": "string" - }, { "description": "the identifier of the Storage Policy in vSphere DataCenter", "name": "policyid", "type": "string" }, { - "description": "the ID of the Storage Policy", - "name": "id", + "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" }, { @@ -58560,14 +58853,19 @@ "type": "string" }, { - "description": "the ID of the Zone", - "name": "zoneid", + "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 name of the Storage Policy", + "name": "name", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -58580,34 +58878,34 @@ "description": "the ID of the port forwarding rule", "length": 255, "name": "id", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "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" + }, + {} ] }, { @@ -58616,11 +58914,12 @@ "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", + "description": "the ID of the vpc", "length": 255, - "name": "tiernetworkofferings", - "required": false, - "type": "map" + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", + "required": true, + "type": "uuid" }, { "description": "true if previous network migration cmd failed", @@ -58629,14 +58928,6 @@ "required": false, "type": "boolean" }, - { - "description": "the ID of the vpc", - "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC,migrateVPC", - "required": true, - "type": "uuid" - }, { "description": "vpc offering ID", "length": 255, @@ -58644,89 +58935,188 @@ "related": "updateVPCOffering,listVPCOfferings", "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" } ], "related": "listVPCs,createVPC,listVPCs,updateVPC", "response": [ { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the domain id of the VPC owner", - "name": "domainid", - "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": "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" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" + } + ], + "type": "list" }, { - "description": "the owner of the VPC", - "name": "account", - "type": "string" + "description": "The routes for the VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, - {}, { - "description": "the name of the VPC", - "name": "name", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, { "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": "the cidr the VPC", + "name": "cidr", + "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { - "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 cidr the VPC", - "name": "cidr", + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + {}, + { + "description": "the id of the VPC", + "name": "id", "type": "string" }, { - "description": "is vpc for display to the regular user", - "name": "fordisplay", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + {}, + { + "description": "true if VPC is region level", + "name": "regionlevelvpc", "type": "boolean" }, + { + "description": "the project id of the VPC", + "name": "projectid", + "type": "string" + }, { "description": "the list of networks belongign to the VPC", "name": "network", "type": "list" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", - "type": "string" - }, - { - "description": "state of the VPC. Can be Inactive/Enabled", - "name": "state", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "true VPC requires restart", - "name": "restartrequired", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { @@ -58735,90 +59125,29 @@ "type": "string" }, { - "description": "the list of supported services", - "name": "service", - "response": [ - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "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", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - } - ], - "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" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" + "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": "the owner of the VPC", + "name": "account", + "type": "string" }, { - "description": "MTU configured on the public interfaces of the VPC VR", - "name": "publicmtu", - "type": "integer" + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" + }, + { + "description": "the name of the VPC", + "name": "name", + "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" }, { "description": "the first IPv6 DNS for the VPC", @@ -58830,24 +59159,23 @@ "name": "jobid", "type": "string" }, - {}, { - "description": "the network domain of the VPC", - "name": "networkdomain", - "type": "string" + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "The IPv4 routing mode of VPC", - "name": "ip4routing", - "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 project", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -58861,13 +59189,8 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -58876,103 +59199,78 @@ "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "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", "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "the first IPv4 DNS for the VPC", - "name": "dns1", + "description": "the network domain of the VPC", + "name": "networkdomain", "type": "string" }, { - "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": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the second IPv4 DNS for the VPC", + "name": "dns2", "type": "string" }, { - "description": "vpc offering name the VPC is created from", - "name": "vpcofferingname", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "the project name of the VPC", - "name": "project", + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", "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", + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", "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", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "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 second IPv6 DNS for the VPC", "name": "ip6dns2", @@ -58996,23 +59294,23 @@ } ], "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": "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", @@ -59026,82 +59324,82 @@ "name": "updateAnnotationVisibility", "params": [ { - "description": "the annotation is visible for admins only", + "description": "the id of the annotation", "length": 255, - "name": "adminsonly", + "name": "id", "required": true, - "type": "boolean" + "type": "string" }, { - "description": "the id of the annotation", + "description": "the annotation is visible for admins only", "length": 255, - "name": "id", + "name": "adminsonly", "required": true, - "type": "string" + "type": "boolean" } ], "related": "addAnnotation,listAnnotations,removeAnnotation", "response": [ - { - "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 (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 type of the annotated entity", - "name": "entitytype", + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" + }, + { + "description": "the (uu)id of the entity to which this annotation pertains", + "name": "entityid", "type": "string" }, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "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 (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, - {}, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" + "description": "the (uu)id of the annotation", + "name": "id", + "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", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the annotated entity", + "name": "entitytype", "type": "string" }, { - "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" } ], @@ -59135,6 +59433,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the Account to update the parameter value for corresponding account", + "length": 255, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, + "type": "uuid" + }, { "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, @@ -59144,18 +59450,17 @@ "type": "uuid" }, { - "description": "the ID of the Cluster to update the parameter value for corresponding cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "description": "the value of the configuration", + "length": 4096, + "name": "value", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -59166,25 +59471,18 @@ "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 category of the configuration", - "name": "category", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the value of the configuration", - "name": "value", + "description": "the group of the configuration", + "name": "group", "type": "string" }, { @@ -59193,18 +59491,25 @@ "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 configuration", - "name": "description", + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" + }, + {}, + { + "description": "the category of the configuration", + "name": "category", "type": "string" }, + {}, { - "description": "the name of the configuration", - "name": "name", + "description": "the subgroup of the configuration", + "name": "subgroup", "type": "string" }, { @@ -59212,45 +59517,39 @@ "name": "id", "type": "long" }, - {}, - { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" - }, { - "description": "the group of the configuration", - "name": "group", + "description": "the type of the configuration value", + "name": "type", "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", - "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", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, { - "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", - "name": "scope", + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { - "description": "the type of the configuration value", - "name": "type", + "description": "the description of the configuration", + "name": "description", "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" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the value of the configuration", + "name": "value", "type": "string" }, { @@ -59258,10 +59557,9 @@ "name": "component", "type": "string" }, - {}, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", + "name": "scope", "type": "string" } ] @@ -59272,32 +59570,27 @@ "name": "configureHAForHost", "params": [ { - "description": "ID of the host", + "description": "HA provider", "length": 255, - "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "name": "provider", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "HA provider", + "description": "ID of the host", "length": 255, - "name": "provider", + "name": "hostid", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": true, - "type": "string" + "type": "uuid" } ], "related": "enableHAForHost,disableHAForHost", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - { - "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": "operation status", @@ -59311,21 +59604,26 @@ "type": "boolean" }, { - "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 HA state of the host", "name": "hastate", "type": "hastate" }, - {} + { + "description": "the host HA provider", + "name": "haprovider", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.11" }, @@ -59335,33 +59633,26 @@ "name": "listVolumesUsageHistory", "params": [ { - "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 volumes, mutually exclusive with id.", + "description": "", "length": 255, - "name": "ids", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "name": "pagesize", "required": false, - "type": "list" + "type": "integer" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", + "description": "the IDs of the volumes, mutually exclusive with id.", "length": 255, - "name": "name", + "name": "ids", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", "required": false, - "type": "string" + "type": "list" }, { "description": "the ID of the volume.", @@ -59379,30 +59670,37 @@ "type": "string" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "name of the volume (a substring match is made against the parameter value returning the data for all matching Volumes).", "length": 255, - "name": "enddate", + "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": "", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "page", + "name": "enddate", "required": false, - "type": "integer" + "type": "date" } ], "related": "", "response": [ { - "description": "the list of VM stats", - "name": "stats", - "type": "list" + "description": "the name of the volume", + "name": "name", + "type": "string" }, { - "description": "the ID of the volume", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -59411,17 +59709,17 @@ "type": "integer" }, { - "description": "the name of the volume", - "name": "name", - "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", + "description": "the ID of the volume", + "name": "id", "type": "string" - } + }, + {}, + {} ], "since": "4.18.0" }, @@ -59439,18 +59737,18 @@ "type": "uuid" }, { - "description": "domain ID of the account owning a VLAN", + "description": "the id of the VLAN IP range", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "id", + "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", "required": true, "type": "uuid" }, { - "description": "the id of the VLAN IP range", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "id", - "related": "createVlanIpRange,updateVlanIpRange,dedicatePublicIpRange", + "name": "domainid", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": true, "type": "uuid" }, @@ -59465,14 +59763,14 @@ "related": "createVlanIpRange,updateVlanIpRange", "response": [ { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, { - "description": "indicates whether VLAN IP range is dedicated to system vms or not", - "name": "forsystemvms", - "type": "boolean" + "description": "the Pod name for the VLAN IP range", + "name": "podname", + "type": "string" }, { "description": "the cidr of the VLAN IP range", @@ -59480,29 +59778,28 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, - {}, { - "description": "the virtual network for the VLAN IP range", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the network id of vlan range", + "name": "networkid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the domain to which the VLAN IP range belongs", + "name": "domainpath", "type": "string" }, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { @@ -59510,100 +59807,101 @@ "name": "domain", "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 Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 netmask of the VLAN IP range", - "name": "netmask", + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "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 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 Pod ID for the VLAN IP range", - "name": "podid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { - "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": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the Pod ID for the VLAN IP range", + "name": "podid", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the start ipv6 of the VLAN IP range", - "name": "startipv6", - "type": "string" + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" }, { - "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 end ip of the VLAN IP range", - "name": "endip", + "description": "the ID of the VLAN IP range", + "name": "id", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, - {}, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the netmask of the VLAN IP range", + "name": "netmask", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" } ] @@ -59623,7 +59921,17 @@ } ], "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", @@ -59634,17 +59942,7 @@ "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" }, @@ -59653,6 +59951,22 @@ "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": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, + "type": "uuid" + }, { "description": "The rule permission, allow or deny. Default: deny.", "length": 255, @@ -59667,35 +59981,20 @@ "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, "name": "description", "required": false, "type": "string" - }, - { - "description": "ID of project where project role permission is to be created", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": true, - "type": "uuid" } ], "related": "listProjectRolePermissions", "response": [ + {}, { - "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" }, { @@ -59704,13 +60003,19 @@ "type": "string" }, { - "description": "the description of the role permission", - "name": "description", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, + {}, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "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" }, { @@ -59718,21 +60023,14 @@ "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 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 api name or wildcard rule", - "name": "rule", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { @@ -59759,7 +60057,7 @@ "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } @@ -59767,8 +60065,13 @@ "related": "", "response": [ { - "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": "details in case of an error", + "name": "details", "type": "string" }, { @@ -59776,28 +60079,23 @@ "name": "url", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the console websocket options", - "name": "websocket", - "type": "consoleendpointwebsocketresponse" - }, { - "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": "true if the console endpoint is generated properly", "name": "success", "type": "boolean" }, - {} + { + "description": "the console websocket options", + "name": "websocket", + "type": "consoleendpointwebsocketresponse" + } ], "since": "4.18.0" }, @@ -59807,12 +60105,12 @@ "name": "updateProjectRolePermission", "params": [ { - "description": "ID of the project role", + "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": true, - "type": "uuid" + "name": "ruleorder", + "related": "listProjectRolePermissions", + "required": false, + "type": "list" }, { "description": "Rule permission, can be: allow or deny", @@ -59822,21 +60120,13 @@ "type": "string" }, { - "description": "Project Role permission rule id", + "description": "ID of the project role", "length": 255, - "name": "projectrolepermissionid", - "related": "listProjectRolePermissions", - "required": false, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": true, "type": "uuid" }, - { - "description": "The parent role permission uuid, use 0 to move this rule at the top of the list", - "length": 255, - "name": "ruleorder", - "related": "listProjectRolePermissions", - "required": false, - "type": "list" - }, { "description": "ID of project where project role permission is to be updated", "length": 255, @@ -59844,30 +60134,38 @@ "related": "activateProject,createProject,suspendProject", "required": true, "type": "uuid" + }, + { + "description": "Project Role permission rule id", + "length": 255, + "name": "projectrolepermissionid", + "related": "listProjectRolePermissions", + "required": false, + "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": "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.15.0" @@ -59877,6 +60175,14 @@ "isasync": true, "name": "addUserToProject", "params": [ + { + "description": "ID of the project role", + "length": 255, + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", + "required": false, + "type": "uuid" + }, { "description": "ID of the project to add the user to", "length": 255, @@ -59893,51 +60199,43 @@ "type": "string" }, { - "description": "email ID of user to which invitation to the project is going to be sent", + "description": "Name of the user to be added to the project", "length": 255, - "name": "email", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "ID of the project role", + "description": "email ID of user to which invitation to the project is going to be sent", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", + "name": "email", "required": false, - "type": "uuid" - }, - { - "description": "Name of the user to be added to the project", - "length": 255, - "name": "username", - "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" - }, { "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.14" }, @@ -59956,16 +60254,13 @@ } ], "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", @@ -59976,8 +60271,11 @@ "name": "displaytext", "type": "string" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.11" }, @@ -59986,13 +60284,6 @@ "isasync": true, "name": "deleteTungstenFabricFirewallPolicy", "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall policy", - "length": 255, - "name": "firewallpolicyuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -60000,26 +60291,33 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "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": "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", @@ -60036,473 +60334,503 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "response": [ - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - {}, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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 group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "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 name of the domain in which the virtual machine exists", - "name": "domain", - "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", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "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": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - {}, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "type": "long" - }, - { - "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": "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 service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "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": "Instance lease duration in days", - "name": "leaseduration", + "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", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - { - "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 name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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", + "description": "the domain ID of the security 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": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the user's name who deployed the virtual machine", - "name": "username", - "type": "string" - }, - { - "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": "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 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", + "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": "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": "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": "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 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": "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" + } + ], + "type": "set" + }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "tag key name", - "name": "key", - "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": "account owning the security group rule", + "name": "account", + "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 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": "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", + "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": "tag value", + "name": "value", + "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": "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 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": "id of the resource", - "name": "resourceid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the list of resource tags associated with the rule", + "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": "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": "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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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 account associated with the tag", - "name": "account", + "description": "the project name of the group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "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", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" + "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 ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "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": "the project name of the vm", - "name": "project", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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 host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "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 host for the virtual machine", - "name": "hostid", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { @@ -60510,8 +60838,8 @@ "name": "nic", "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -60520,13 +60848,28 @@ "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -60534,34 +60877,104 @@ "name": "ipaddresses", "type": "list" }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, { "description": "the netmask of the nic", "name": "netmask", "type": "string" }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "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": "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": "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, { "description": "the Secondary ipv4 addr of nic", "name": "secondaryip", "type": "list" }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "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": "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": "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -60570,176 +60983,303 @@ "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "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 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 project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "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": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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 IPv6 address of network", - "name": "ip6address", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the nic", + "description": "the account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the type of the affinity group", "name": "type", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "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 description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "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" } ], "type": "set" }, { - "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" + "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 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": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "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": "publicipid", + "type": "string" }, + {}, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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 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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + {}, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -60748,64 +61288,174 @@ "type": "integer" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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": "ssh key-pairs", - "name": "keypairs", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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 received", - "name": "receivedbytes", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the group name of the virtual machine", + "name": "group", + "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 availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "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 ID of the template for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", @@ -60813,390 +61463,38 @@ "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": "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" - }, - { - "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 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" - } - ], - "type": "set" - }, - { - "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 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": "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": "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": "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": "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": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "the type of the ICMP message response", - "name": "icmptype", - "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "tag value", - "name": "value", - "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": "the project name where tag belongs to", - "name": "project", - "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 project id the tag belongs to", - "name": "projectid", - "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" - } - ], - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - } - ], - "type": "set" - }, - { - "description": "the name of the security group", - "name": "name", - "type": "string" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "description": "the ID of the security group", - "name": "id", - "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 virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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 vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" } ] @@ -61216,17 +61514,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 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", @@ -61234,9 +61532,9 @@ }, {}, { - "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.0" @@ -61246,13 +61544,6 @@ "isasync": true, "name": "updateBgpPeer", "params": [ - { - "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" - }, { "description": "Id of the Bgp Peer", "length": 255, @@ -61262,16 +61553,9 @@ "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.", + "description": "The IPv6 address of the Bgp Peer.", "length": 255, - "name": "ipaddress", + "name": "ip6address", "required": false, "type": "string" }, @@ -61283,51 +61567,59 @@ "type": "map" }, { - "description": "The IPv6 address of the Bgp Peer.", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "ip6address", + "name": "password", "required": false, "type": "string" }, { - "description": "The password of the Bgp Peer.", + "description": "The IPv4 address of the Bgp Peer.", "length": 255, - "name": "password", + "name": "ipaddress", "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" + }, + { + "description": "The AS number of the Bgp Peer.", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" } ], "related": "createBgpPeer,listBgpPeers,dedicateBgpPeer,releaseBgpPeer", "response": [ { - "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": "AS number of bgp peer", - "name": "asnumber", - "type": "long" - }, - { - "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", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { @@ -61336,51 +61628,57 @@ "type": "date" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the domain ID of the bgp peer", + "name": "domainid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, {}, { - "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": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "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", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { "description": "the account of the bgp peer", "name": "account", "type": "string" - } + }, + { + "description": "the project name of the bgp peer", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.20.0" }, @@ -61389,32 +61687,39 @@ "isasync": true, "name": "updateTungstenFabricLBHealthMonitor", "params": [ + { + "description": "loadbalancer health monitor expected code", + "length": 255, + "name": "expectedcode", + "required": false, + "type": "string" + }, { "description": "the ID of lb rule", "length": 255, "name": "lbruleid", - "related": "createRoutingFirewallRule,listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,createRoutingFirewallRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, { - "description": "loadbalancer health monitor timeout", + "description": "loadbalancer health monitor interval", "length": 255, - "name": "timeout", + "name": "interval", "required": true, "type": "integer" }, { - "description": "loadbalancer health monitor expected code", + "description": "loadbalancer health monitor retry", "length": 255, - "name": "expectedcode", - "required": false, - "type": "string" + "name": "retry", + "required": true, + "type": "integer" }, { - "description": "loadbalancer health monitor interval", + "description": "loadbalancer health monitor timeout", "length": 255, - "name": "interval", + "name": "timeout", "required": true, "type": "integer" }, @@ -61426,23 +61731,16 @@ "type": "string" }, { - "description": "loadbalancer health monitor retry", - "length": 255, - "name": "retry", - "required": true, - "type": "integer" - }, - { - "description": "loadbalancer health monitor url path", + "description": "loadbalancer health monitor http method", "length": 255, - "name": "urlpath", + "name": "httpmethodtype", "required": false, "type": "string" }, { - "description": "loadbalancer health monitor http method", + "description": "loadbalancer health monitor url path", "length": 255, - "name": "httpmethodtype", + "name": "urlpath", "required": false, "type": "string" } @@ -61450,18 +61748,19 @@ "related": "", "response": [ { - "description": "the health monitor UUID", - "name": "uuid", + "description": "the health monitor expected code", + "name": "expectedcode", "type": "string" }, + {}, { - "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", + "description": "the health monitor url path", + "name": "urlpath", "type": "string" }, { @@ -61470,8 +61769,8 @@ "type": "string" }, { - "description": "the health monitor expected code", - "name": "expectedcode", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { @@ -61480,46 +61779,45 @@ "type": "int" }, {}, + { + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", + "description": "the health monitor ID", + "name": "id", "type": "long" }, { - "description": "the health monitor retry", - "name": "retry", + "description": "the health monitor interval", + "name": "interval", "type": "int" }, { - "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": "the health monitor url path", - "name": "urlpath", + "description": "the health monitor UUID", + "name": "uuid", "type": "string" }, { "description": "the health monitor http method", "name": "httpmethod", "type": "string" - }, - { - "description": "the health monitor ID", - "name": "id", - "type": "long" } ] }, @@ -61532,34 +61830,34 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,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": "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": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {} ] }, { @@ -61567,6 +61865,13 @@ "isasync": true, "name": "updateProjectInvitation", "params": [ + { + "description": "account that is joining the project", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "User UUID, required for adding account from external provisioning system", "length": 255, @@ -61589,13 +61894,6 @@ "required": false, "type": "string" }, - { - "description": "account that is joining the project", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "id of the project to join", "length": 255, @@ -61606,27 +61904,27 @@ } ], "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "3.0.0" @@ -61648,25 +61946,44 @@ "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "response": [ { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", + "description": "the type of the snapshot", + "name": "snapshottype", + "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": "state of the snapshot on the datastore", - "name": "datastorestate", + "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", "type": "string" }, {}, { - "description": "the project name of the snapshot", - "name": "project", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { @@ -61675,33 +61992,43 @@ "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "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 snapshot's account belongs to", - "name": "domainpath", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, { "description": "the account associated with the snapshot", "name": "account", "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": "id of the availability zone", + "name": "zoneid", "type": "string" }, { @@ -61710,23 +62037,18 @@ "type": "boolean" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "name of the availability zone", + "name": "zonename", "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 type of the snapshot", - "name": "snapshottype", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, { @@ -61735,18 +62057,18 @@ "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 datastore for the snapshot entry", - "name": "datastoreid", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { @@ -61755,37 +62077,57 @@ "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the status of the template", + "name": "status", + "type": "string" + }, + { + "description": "display name of the os on volume", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the domain name of the snapshot's account", + "name": "domain", + "type": "string" + }, + { + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "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 project id the tag belongs to", - "name": "projectid", + "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": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -61794,13 +62136,13 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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" }, { @@ -61809,76 +62151,32 @@ "type": "string" }, { - "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" } ], "type": "set" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" - }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, - { - "description": "display name of the os on volume", - "name": "osdisplayname", - "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": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "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", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, + {}, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" } ] @@ -61913,9 +62211,9 @@ ], "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", @@ -61924,16 +62222,16 @@ }, {}, { - "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.18.0" }, @@ -61943,11 +62241,18 @@ "name": "listRegions", "params": [ { - "description": "List Region by region ID.", + "description": "List Region by region name.", "length": 255, - "name": "id", + "name": "name", "required": false, - "type": "integer" + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -61957,11 +62262,11 @@ "type": "integer" }, { - "description": "List Region by region name.", + "description": "List Region by region ID.", "length": 255, - "name": "name", + "name": "id", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -61969,28 +62274,10 @@ "name": "pagesize", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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 end point of the region", - "name": "endpoint", - "type": "string" - }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -62001,21 +62288,32 @@ "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", - "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", "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" } ] }, @@ -62033,11 +62331,19 @@ "since": "4.16.0", "type": "uuid" }, + { + "description": "the ID of the virtual machine", + "length": 255, + "name": "virtualmachineid", + "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", + "required": true, + "type": "uuid" + }, { "description": "destination Host ID to migrate VM to", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, @@ -62048,128 +62354,114 @@ "required": false, "since": "4.16.0", "type": "boolean" - }, - { - "description": "the ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "related": "migrateSystemVm,startSystemVm,changeServiceForSystemVm", - "required": true, - "type": "uuid" } ], "related": "startSystemVm,changeServiceForSystemVm", "response": [ { - "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 network domain for the system VM", - "name": "networkdomain", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "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 ID of the system VM", "name": "id", "type": "string" }, - { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - {}, - { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, + {}, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "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", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the host ID for the system VM", + "name": "hostid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the template name for the system VM", - "name": "templatename", + "description": "the systemvm agent version", + "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Zone name for the system VM", + "name": "zonename", + "type": "string" + }, + { + "description": "the name of the system VM", + "name": "name", + "type": "string" + }, + { + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { @@ -62178,13 +62470,13 @@ "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { @@ -62193,8 +62485,8 @@ "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { @@ -62202,69 +62494,75 @@ "name": "state", "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "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": "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": "the hostname for the system VM", - "name": "hostname", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" } ] @@ -62274,6 +62572,20 @@ "isasync": false, "name": "listCounters", "params": [ + { + "description": "Source of the counter.", + "length": 255, + "name": "source", + "required": false, + "type": "string" + }, + { + "description": "Name of the counter.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Network provider of the counter.", "length": 255, @@ -62282,6 +62594,13 @@ "since": "4.18.0", "type": "string" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -62303,39 +62622,18 @@ "related": "createCounter,listCounters", "required": false, "type": "uuid" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "Name of the counter.", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "Source of the counter.", - "length": 255, - "name": "source", - "required": false, - "type": "string" } ], "related": "createCounter", "response": [ { - "description": "Provider of the counter.", - "name": "provider", + "description": "the id of the Counter", + "name": "id", "type": "string" }, { - "description": "the id of the Counter", - "name": "id", + "description": "Value in case of snmp or other specific counters.", + "name": "value", "type": "string" }, { @@ -62344,31 +62642,31 @@ "type": "string" }, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, {}, + {}, { - "description": "Source of the counter.", - "name": "source", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", - "type": "integer" } ] }, @@ -62395,16 +62693,7 @@ ], "related": "listInternalLoadBalancerElements", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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", @@ -62415,13 +62704,22 @@ "name": "nspid", "type": "string" }, + {}, + { + "description": "the id of the internal load balancer element", + "name": "id", + "type": "string" + }, { "description": "Enabled/Disabled the element", "name": "enabled", "type": "boolean" }, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.2.0" }, @@ -62438,11 +62736,11 @@ "type": "list" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of networks", "length": 255, - "name": "policyuuid", + "name": "networkuuid", "required": false, - "type": "string" + "type": "list" }, { "description": "the uuid of Tungsten-Fabric tag", @@ -62451,13 +62749,6 @@ "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, @@ -62479,61 +62770,68 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric policy", + "length": 255, + "name": "policyuuid", + "required": false, + "type": "string" } ], "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", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, + {}, + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" }, { - "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 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": "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": "list Tungsten-Fabric vm", - "name": "vm", - "type": "list" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { "description": "list Tungsten-Fabric network", "name": "network", "type": "list" + }, + { + "description": "list Tungsten-Fabric vm", + "name": "vm", + "type": "list" } ] }, @@ -62542,20 +62840,26 @@ "isasync": false, "name": "listVirtualRouterElements", "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list virtual router elements by id", + "description": "", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement,listVirtualRouterElements", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list network offerings by enabled state", @@ -62565,75 +62869,70 @@ "type": "boolean" }, { - "description": "list virtual router elements by network service provider id", + "description": "list virtual router elements by id", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", + "name": "id", + "related": "configureVirtualRouterElement,listVirtualRouterElements", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "list virtual router elements by network service provider id", "length": 255, - "name": "keyword", + "name": "nspid", + "related": "addNetworkServiceProvider,listNetworkServiceProviders,listTrafficTypes", "required": false, - "type": "string" + "type": "uuid" } ], "related": "configureVirtualRouterElement", "response": [ + {}, { - "description": "the id of the router", - "name": "id", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, { - "description": "the account associated with the provider", - "name": "account", + "description": "the domain ID associated with the provider", + "name": "domainid", "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "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" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the account associated with the provider", + "name": "account", + "type": "string" }, - {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the physical network service provider id of the provider", - "name": "nspid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network service provider id of the provider", + "name": "nspid", "type": "string" }, { - "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 project id of the ipaddress", @@ -62641,11 +62940,10 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" - }, - {} + } ] }, { @@ -62663,13 +62961,6 @@ } ], "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", @@ -62680,10 +62971,17 @@ "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.20.0" @@ -62703,7 +63001,17 @@ } ], "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", @@ -62714,16 +63022,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", - "name": "success", - "type": "boolean" - }, {} ], "since": "4.21.0" @@ -62733,6 +63031,13 @@ "isasync": true, "name": "createRoutingFirewallRule", "params": [ + { + "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "length": 255, + "name": "traffictype", + "required": false, + "type": "string" + }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, @@ -62748,23 +63053,24 @@ "type": "integer" }, { - "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 network of the VM the firewall rule will be created for", "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", + "required": true, + "type": "uuid" }, { - "description": "the starting port of firewall rule", + "description": "type of the ICMP message being sent", "length": 255, - "name": "startport", + "name": "icmptype", "required": false, "type": "integer" }, @@ -62776,128 +63082,48 @@ "type": "boolean" }, { - "description": "The network of the VM the firewall rule will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks,listBrocadeVcsDeviceNetworks", - "required": true, - "type": "uuid" - }, - { - "description": "the source CIDR list to allow traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "cidrlist", + "name": "destcidrlist", "required": false, "type": "list" }, { - "description": "the destination CIDR list to allow traffic to. Multiple entries must be separated by a single comma character (,).", + "description": "the starting port of firewall rule", "length": 255, - "name": "destcidrlist", + "name": "startport", "required": false, - "type": "list" + "type": "integer" }, { - "description": "the traffic type for the Routing firewall rule, can be ingress or egress, defaulted to ingress if not specified", + "description": "the ending port of firewall rule", "length": 255, - "name": "traffictype", + "name": "endport", "required": false, - "type": "string" + "type": "integer" } ], - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "response": [ { - "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 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": "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": "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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "type": "string" }, {}, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "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 VM name for the port forwarding rule", - "name": "virtualmachinename", + "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 public port range", - "name": "publicport", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { @@ -62906,18 +63132,13 @@ "type": "string" }, { - "description": "the ending port of port forwarding rule's private port range", - "name": "privateendport", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -62931,23 +63152,29 @@ "type": "boolean" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", + "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 protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", + "type": "string" + }, + { + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -62960,7 +63187,78 @@ "name": "networkid", "type": "string" }, - {} + { + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", + "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 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": "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.20.0" }, @@ -62984,10 +63282,10 @@ "type": "integer" }, { - "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "description": "name of the account, it will be created if it does not exist", "length": 255, - "name": "type", - "required": false, + "name": "account", + "required": true, "type": "string" }, { @@ -63005,6 +63303,13 @@ "required": false, "type": "string" }, + { + "description": "type of the ldap name. GROUP or OU, defaults to GROUP", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { "description": "Creates the account under the specified role.", "length": 255, @@ -63013,21 +63318,13 @@ "required": false, "since": "4.19.1", "type": "uuid" - }, - { - "description": "name of the account, it will be created if it does not exist", - "length": 255, - "name": "account", - "required": true, - "type": "string" } ], "related": "", "response": [ - {}, { - "description": "type of the name in LDAP which is linked to the domain", - "name": "type", + "description": "id of the Domain which is linked to LDAP", + "name": "domainid", "type": "string" }, { @@ -63036,16 +63333,6 @@ "type": "string" }, {}, - { - "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", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -63056,14 +63343,25 @@ "name": "name", "type": "string" }, + { + "description": "type of the name in LDAP which is linked to the domain", + "name": "type", + "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", + "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", "type": "string" } ], @@ -63078,79 +63376,79 @@ "description": "the ID of the host", "length": 255, "name": "hostid", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": true, "type": "uuid" } ], "related": "enableOutOfBandManagementForHost,disableOutOfBandManagementForCluster,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ - { - "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 action (if issued)", - "name": "action", + "description": "the ID of the host", + "name": "hostid", "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 ID of the host", - "name": "hostid", + "description": "the out-of-band management interface address", + "name": "address", "type": "string" }, { - "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 driver for the host", + "name": "driver", "type": "string" }, + {}, { - "description": "the out-of-band management interface password", - "name": "password", - "type": "string" + "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 interface username", + "name": "username", "type": "string" }, { - "description": "the out-of-band management driver for the host", - "name": "driver", + "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 operation result description", + "name": "description", "type": "string" }, { "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", + "type": "string" } ], "since": "4.9.0" @@ -63164,91 +63462,167 @@ "description": "host ID", "length": 255, "name": "id", - "related": "cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,cancelHostAsDegraded,declareHostAsDegraded,listHosts,reconnectHost", "required": true, "type": "uuid" } ], - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "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 Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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 zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "the OS category ID of the host", + "name": "oscategoryid", + "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", "type": "integer" }, + {}, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, + { + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, { "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 cluster ID of the host", + "name": "clusterid", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" + }, + { + "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 ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", + "description": "the name of the host", + "name": "name", + "type": "string" + }, + { + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, + { + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "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": "events available for the host", "name": "events", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "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" }, { @@ -63260,18 +63634,18 @@ "name": "vgpu", "response": [ { - "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" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -63280,23 +63654,23 @@ "type": "long" }, { - "description": "Maximum displays per user", - "name": "maxheads", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "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", - "type": "long" + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { - "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" } ], @@ -63311,65 +63685,80 @@ "type": "list" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the last annotation set on this host by an admin", + "name": "annotation", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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 ID of extension for this cluster", - "name": "extensionid", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "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": "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 OS category name of the host", - "name": "oscategoryname", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, + {}, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "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", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { "description": "the Zone name of the host", @@ -63377,241 +63766,150 @@ "type": "string" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the name of the host", - "name": "name", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "the Zone ID of the host", + "name": "zoneid", + "type": "string" }, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - {}, - { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "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 host hypervisor", - "name": "hypervisor", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the date and time the host was last pinged", - "name": "lastpinged", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, { "description": "the host version", "name": "version", "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" - }, - { - "description": "capabilities of the host", - "name": "capabilities", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "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": "the admin that annotated this host", - "name": "username", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the cluster name of the host", + "name": "clustername", "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": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" - }, - { - "description": "the Pod name of the host", - "name": "podname", + "description": "the management server ID of the host", + "name": "managementserverid", "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 entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" - }, - { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "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 host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the management server name of the host", + "name": "managementservername", "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": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" - }, - { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" - }, - {}, - { - "description": "the ID of the host", - "name": "id", + "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 percentage", - "name": "memoryallocatedpercentage", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the resource state of the host", + "name": "resourcestate", "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", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "type": "string" - }, - { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" } ], "since": "4.16.0.0" @@ -63621,13 +63919,6 @@ "isasync": false, "name": "releaseASNumber", "params": [ - { - "description": "the AS Number to be released", - "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - }, { "description": "the zone ID", "length": 255, @@ -63635,31 +63926,38 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "the AS Number to be released", + "length": 255, + "name": "asnumber", + "required": true, + "type": "long" } ], "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.20.0" }, @@ -63682,13 +63980,6 @@ "required": false, "type": "string" }, - { - "description": "an optional account for the security group. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, @@ -63704,44 +63995,26 @@ "related": "activateProject,createProject,suspendProject", "required": false, "type": "uuid" + }, + { + "description": "an optional account for the security group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "updateSecurityGroup", "response": [ { - "description": "the project id of the group", - "name": "projectid", - "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", + "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 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": "security group name", "name": "securitygroupname", @@ -63752,8 +64025,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -63762,23 +64035,23 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "the account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -63787,36 +64060,36 @@ "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" }, { - "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" } ], "type": "set" }, { - "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 type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -63825,10 +64098,15 @@ "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": "account owning the security group rule", + "name": "account", + "type": "string" + }, { "description": "the id of the security group rule", "name": "ruleid", @@ -63840,61 +64118,45 @@ "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 ID of the security group", - "name": "domainid", - "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "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": "id of the resource", + "name": "resourceid", "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" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -63903,18 +64165,18 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -63925,25 +64187,30 @@ ], "type": "set" }, - {}, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the security 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 project id of the group", + "name": "projectid", + "type": "string" }, + {}, { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { @@ -63951,13 +64218,8 @@ "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -63965,6 +64227,26 @@ "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 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", @@ -63975,13 +64257,13 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -63990,33 +64272,33 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -64027,39 +64309,55 @@ ], "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 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", - "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" } ], "type": "set" }, + { + "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 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 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 security group", "name": "description", @@ -64083,26 +64381,12 @@ ], "related": "", "response": [ - { - "description": "the ID of project the network is available for", - "name": "projectid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the project the network is available for", "name": "project", "type": "string" }, - { - "description": "the account the network is available for", - "name": "account", - "type": "string" - }, { "description": "the ID of account the network is available for", "name": "accountid", @@ -64113,15 +64397,29 @@ "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 to which the network belongs", + "name": "domain", + "type": "string" + }, { "description": "the ID of the domain to which the network belongs", "name": "domainid", "type": "string" }, { - "description": "the name of the domain to which the network belongs", - "name": "domain", + "description": "the ID of project the network is available for", + "name": "projectid", + "type": "string" + }, + { + "description": "the account the network is available for", + "name": "account", "type": "string" }, {}, @@ -64138,45 +64436,45 @@ "isasync": true, "name": "removeVirtualMachineFromBackupOffering", "params": [ - { - "description": "ID of the virtual machine", - "length": 255, - "name": "virtualmachineid", - "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" + }, + { + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", + "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", + "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": "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.14.0" }, @@ -64185,6 +64483,22 @@ "isasync": false, "name": "listVpnGateways", "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": "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, @@ -64200,19 +64514,19 @@ "type": "string" }, { - "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 resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "activateProject,createProject,suspendProject", "required": false, - "since": "4.4", - "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.", @@ -64222,19 +64536,19 @@ "type": "boolean" }, { - "description": "id of vpc", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "id of vpc", "length": 255, - "name": "keyword", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "type": "string" + "type": "uuid" }, { "description": "id of the vpn gateway", @@ -64244,22 +64558,6 @@ "required": false, "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": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "activateProject,createProject,suspendProject", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, @@ -64271,59 +64569,59 @@ "related": "createVpnGateway,updateVpnGateway", "response": [ { - "description": "the project name", - "name": "project", - "type": "string" - }, - { - "description": "the project id", - "name": "projectid", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the owner", + "name": "account", "type": "string" }, - {}, { - "description": "the public IP address", - "name": "publicip", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "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 vpn gateway ID", "name": "id", "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": "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 project id", + "name": "projectid", "type": "string" }, { - "description": "the owner", - "name": "account", + "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" + }, + { + "description": "the project name", + "name": "project", "type": "string" }, { @@ -64332,14 +64630,14 @@ "type": "string" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the vpc name of this gateway", + "name": "vpcname", + "type": "string" }, {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the public IP address", + "name": "publicip", "type": "string" } ] @@ -64349,13 +64647,6 @@ "isasync": false, "name": "addNetrisProvider", "params": [ - { - "description": "Netris tag for vNets", - "length": 255, - "name": "netristag", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -64365,16 +64656,16 @@ "type": "uuid" }, { - "description": "Password to login into Netris", + "description": "Netris provider name", "length": 255, - "name": "password", + "name": "name", "required": true, "type": "string" }, { - "description": "Netris Tenant name", + "description": "Username to login into Netris", "length": 255, - "name": "tenantname", + "name": "username", "required": true, "type": "string" }, @@ -64386,23 +64677,30 @@ "type": "string" }, { - "description": "Username to login into Netris", + "description": "Netris tag for vNets", "length": 255, - "name": "username", + "name": "netristag", "required": true, "type": "string" }, { - "description": "Netris provider URL", + "description": "Netris Tenant name", "length": 255, - "name": "netrisurl", + "name": "tenantname", "required": true, "type": "string" }, { - "description": "Netris provider name", + "description": "Password to login into Netris", "length": 255, - "name": "name", + "name": "password", + "required": true, + "type": "string" + }, + { + "description": "Netris provider URL", + "length": 255, + "name": "netrisurl", "required": true, "type": "string" } @@ -64410,13 +64708,8 @@ "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", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, { @@ -64425,40 +64718,45 @@ "type": "string" }, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Tag for vNets", + "name": "netristag", "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 Netris Provider is associated with", + "name": "zoneid", + "type": "string" }, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, + {}, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Netris Provider URL", "name": "netrisurl", "type": "string" }, - {}, { - "description": "Netris Tag for vNets", - "name": "netristag", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, - {}, { - "description": "Netris Provider site", - "name": "sitename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -64470,11 +64768,11 @@ "name": "moveUser", "params": [ { - "description": "id of the user to be moved.", + "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", "length": 255, - "name": "id", - "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", - "required": true, + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", + "required": false, "type": "uuid" }, { @@ -64485,11 +64783,11 @@ "type": "string" }, { - "description": "Moves the user under the specified account. If no account id is specified, it is necessary to provide an account name.", + "description": "id of the user to be moved.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", - "required": false, + "name": "id", + "related": "createUser,disableUser,enableUser,getUser,listUsers,lockUser", + "required": true, "type": "uuid" } ], @@ -64500,17 +64798,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": "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", @@ -64528,33 +64826,33 @@ "description": "the host ID", "length": 255, "name": "id", - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "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" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -64563,6 +64861,14 @@ "isasync": true, "name": "createVpnConnection", "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": "connection is passive or not", "length": 255, @@ -64585,118 +64891,105 @@ "related": "createVpnCustomerGateway,updateVpnCustomerGateway", "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" } ], "related": "updateVpnConnection", "response": [ - {}, - { - "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", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the vpn gateway ID", - "name": "s2svpngatewayid", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the connection ID", + "name": "id", + "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": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", + "description": "Lifetime of IKE SA of customer gateway", + "name": "ikelifetime", "type": "long" }, { - "description": "State of vpn connection", - "name": "state", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "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": "public ip address id of the customer gateway", - "name": "gateway", + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", "type": "boolean" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the vpn gateway ID", + "name": "s2svpngatewayid", "type": "string" }, { - "description": "the customer gateway ID", - "name": "s2scustomergatewayid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "State of vpn connection", + "name": "passive", + "type": "boolean" }, { - "description": "the connection ID", - "name": "id", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, + {}, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "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 date and time the host was created", - "name": "created", - "type": "date" + "description": "the customer gateway ID", + "name": "s2scustomergatewayid", + "type": "string" }, { "description": "the date and time the host was removed", @@ -64704,41 +64997,46 @@ "type": "date" }, { - "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": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", - "type": "string" + "description": "Lifetime of ESP SA of customer gateway", + "name": "esplifetime", + "type": "long" }, { - "description": "the project name", - "name": "project", + "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": "State of vpn connection", + "name": "state", "type": "string" }, + {}, { - "description": "State of vpn connection", - "name": "passive", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "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": "the domain name of the owner", - "name": "domain", + "description": "the project id", + "name": "projectid", "type": "string" }, - {} + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + } ] }, { @@ -64749,14 +65047,14 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -64779,23 +65077,28 @@ "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "response": [ { - "description": "the type of the network", - "name": "type", + "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 Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "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" }, { @@ -64804,79 +65107,58 @@ "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "list networks available for vm deployment", + "name": "canusefordeploy", "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 name of the network", - "name": "name", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, { "description": "availability of the network offering the network is created from", "name": "networkofferingavailability", "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" - }, - { - "description": "zone id of the network", - "name": "zoneid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "the id of the network", - "name": "id", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -64884,8 +65166,8 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -64894,172 +65176,128 @@ "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": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "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": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], "type": "list" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" - }, - { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", - "type": "string" - }, - { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "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": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, + {}, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "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": "true network requires restart", - "name": "restartrequired", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", + "description": "true if network is system, false otherwise", + "name": "issystem", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the owner of the network", + "name": "account", "type": "string" }, + {}, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the type of the network", + "name": "type", "type": "string" }, { @@ -65068,48 +65306,33 @@ "type": "resourceiconresponse" }, { - "description": "the project name of the address", - "name": "project", - "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 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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { @@ -65117,28 +65340,50 @@ "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { "description": "the service provider name", "name": "provider", "response": [ + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the destination physical network", "name": "destinationphysicalnetworkid", "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" + "description": "state of the network provider", + "name": "state", + "type": "string" }, { "description": "uuid of the network provider", @@ -65146,102 +65391,130 @@ "type": "string" }, { - "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 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": "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": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", + "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's gateway", - "name": "gateway", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the name of the network", + "name": "name", "type": "string" }, + { + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" + }, { "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", + "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", + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", "type": "string" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "the displaytext of the network", + "name": "displaytext", + "type": "string" + }, + { + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "the details of the network", + "name": "details", + "type": "map" + }, + { + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" }, { "description": "network offering id the network is created from", @@ -65249,9 +65522,9 @@ "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" }, { "description": "the network's netmask", @@ -65259,48 +65532,73 @@ "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "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": "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", - "name": "state", + "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": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "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 second IPv6 DNS for the network", + "name": "ip6dns2", + "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": "list networks available for vm deployment", - "name": "canusefordeploy", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", + "type": "string" + }, + { + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "state of the network", + "name": "state", "type": "string" } ] @@ -65325,12 +65623,6 @@ "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", @@ -65341,6 +65633,12 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, {} ], "since": "4.21.0" @@ -65351,19 +65649,19 @@ "name": "listWebhookDeliveries", "params": [ { - "description": "List by keyword", + "description": "The ID of the Webhook delivery", "length": 255, - "name": "keyword", + "name": "id", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The ID of the management server", + "description": "", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "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.", @@ -65380,64 +65678,69 @@ "type": "integer" }, { - "description": "The ID of the Webhook delivery", + "description": "The event type of the Webhook delivery", "length": 255, - "name": "id", - "related": "", + "name": "eventtype", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "The ID of the Webhook", + "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": "webhookid", - "related": "createWebhook,listWebhookDeliveries", + "name": "startdate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "The event type of the Webhook delivery", + "description": "The ID of the management server", "length": 255, - "name": "eventtype", + "name": "managementserverid", + "related": "listManagementServers", "required": false, - "type": "string" + "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 listed.", + "description": "List by keyword", "length": 255, - "name": "startdate", + "name": "keyword", "required": false, - "type": "date" + "type": "string" }, { - "description": "", + "description": "The ID of the Webhook", "length": 255, - "name": "pagesize", + "name": "webhookid", + "related": "createWebhook,listWebhookDeliveries", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "createWebhook", "response": [ { - "description": "The payload URL end point for the Webhook", - "name": "payloadurl", + "description": "The ID of the Webhook", + "name": "id", "type": "string" }, - {}, { "description": "The name of the Webhook", "name": "name", "type": "string" }, + {}, { - "description": "The ID of the domain in which the Webhook exists", - "name": "domainid", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, { - "description": "The description of the Webhook", - "name": "description", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The secret key for the Webhook", + "name": "secretkey", "type": "string" }, { @@ -65445,65 +65748,60 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "Whether SSL verification is enabled for the Webhook", - "name": "sslverification", - "type": "boolean" - }, { "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": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { - "description": "The account associated with the Webhook", - "name": "account", + "description": "The scope of the Webhook", + "name": "scope", "type": "string" }, { - "description": "The state of the Webhook", - "name": "state", + "description": "path of the domain to which the Webhook belongs", + "name": "domainpath", "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, { - "description": "The ID of the Webhook", - "name": "id", + "description": "The payload URL end point for the Webhook", + "name": "payloadurl", "type": "string" }, { - "description": "The secret key for the Webhook", - "name": "secretkey", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", - "type": "string" + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { - "description": "path of the domain to which the Webhook belongs", - "name": "domainpath", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" } ], @@ -65514,6 +65812,13 @@ "isasync": true, "name": "dedicateHost", "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, @@ -65522,18 +65827,11 @@ "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" - }, { "description": "the ID of the host to update", "length": 255, "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "required": true, "type": "uuid" } @@ -65541,31 +65839,26 @@ "related": "listDedicatedHosts", "response": [ { - "description": "the ID of the host", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the domain ID of the host", + "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 host", @@ -65573,13 +65866,18 @@ "type": "string" }, { - "description": "the name of the host", - "name": "hostname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, { - "description": "the domain ID of the host", - "name": "domainid", + "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" } ] @@ -65592,17 +65890,10 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, - { - "description": "Name of the Storage access group", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -65613,41 +65904,34 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "Name of the Storage access group", + "length": 255, + "name": "name", + "required": false, + "type": "string" } ], "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", + "description": "List of Pods in the Storage Access Group", + "name": "pods", "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", + "description": "List of Clusters in the Storage Access Group", + "name": "clusters", "type": "listresponse" }, { @@ -65657,16 +65941,30 @@ }, {}, { - "description": "List of Clusters in the Storage Access Group", - "name": "clusters", + "description": "List of Storage Pools in the Storage Access Group", + "name": "storagepools", + "type": "listresponse" + }, + { + "description": "the ID of the storage access group", + "name": "id", + "type": "string" + }, + { + "description": "the name of the storage access group", + "name": "name", + "type": "string" + }, + { + "description": "List of Hosts in the Storage Access Group", + "name": "hosts", "type": "listresponse" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {} + } ], "since": "4.21.0" }, @@ -65676,31 +65974,31 @@ "name": "addGloboDnsHost", "params": [ { - "description": "Password for GloboDNS", + "description": "the Physical Network ID", "length": 255, - "name": "password", + "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" }, { - "description": "the Physical Network ID", + "description": "Username for GloboDNS", "length": 255, - "name": "physicalnetworkid", - "related": "createPhysicalNetwork,listPhysicalNetworks,updatePhysicalNetwork", + "name": "username", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "GloboDNS url", + "description": "Password for GloboDNS", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" } @@ -65708,26 +66006,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": "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.5.0" }, @@ -65736,8 +66034,9 @@ "isasync": false, "name": "logout", "params": [], - "related": "", + "related": "samlSlo", "response": [ + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -65749,7 +66048,6 @@ "name": "jobid", "type": "string" }, - {}, { "description": "Response description", "name": "description", @@ -65769,6 +66067,13 @@ "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", + "length": 255, + "name": "rules", + "required": true, + "type": "map" + }, { "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", "length": 255, @@ -65777,11 +66082,11 @@ "type": "string" }, { - "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": "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": "rules", - "required": true, - "type": "map" + "name": "ispublic", + "required": false, + "type": "boolean" }, { "description": "The description of the role", @@ -65796,13 +66101,6 @@ "name": "name", "required": true, "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).", - "length": 255, - "name": "ispublic", - "required": false, - "type": "boolean" } ], "related": "createRole,listRoles,updateRole", @@ -65813,15 +66111,15 @@ "type": "string" }, { - "description": "the type of the role", - "name": "type", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the description of the role", @@ -65829,13 +66127,13 @@ "type": "string" }, { - "description": "the state of the role", - "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 role", - "name": "id", + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -65845,14 +66143,14 @@ }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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" } ], "since": "4.15.0" @@ -65862,6 +66160,13 @@ "isasync": false, "name": "quotaEmailTemplateUpdate", "params": [ + { + "description": "The quota email template body, max: 500k characters", + "length": 512000, + "name": "templatebody", + "required": true, + "type": "string" + }, { "description": "Type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", "length": 255, @@ -65882,13 +66187,6 @@ "name": "locale", "required": false, "type": "string" - }, - { - "description": "The quota email template body, max: 500k characters", - "length": 512000, - "name": "templatebody", - "required": true, - "type": "string" } ], "response": [ @@ -65897,23 +66195,23 @@ "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.7.0" }, @@ -65922,6 +66220,14 @@ "isasync": false, "name": "quotaCreditsList", "params": [ + { + "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" + }, { "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, @@ -65930,11 +66236,12 @@ "type": "date" }, { - "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", + "description": "ID of the account for which the credit statement will be generated.", "length": 255, - "name": "isrecursive", + "name": "accountid", + "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts,listAccounts", "required": false, - "type": "boolean" + "type": "uuid" }, { "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.", @@ -65944,50 +66251,36 @@ "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.", + "description": "Whether to generate the credit statement for the provided domain and its children. Defaults to false.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "quotaCredits", "response": [ {}, { - "description": "The credit deposited.", - "name": "credit", - "type": "bigdecimal" - }, - { - "description": "Credit's currency.", - "name": "currency", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "Username of the creditor user.", - "name": "creditorusername", + "description": "ID of the creditor user.", + "name": "creditoruserid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Credit's currency.", + "name": "currency", + "type": "string" }, - {}, { - "description": "ID of the creditor user.", - "name": "creditoruserid", - "type": "string" + "description": "The credit deposited.", + "name": "credit", + "type": "bigdecimal" }, { "description": "When the credit was added.", @@ -65995,9 +66288,14 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" } ], "since": "4.21.0" @@ -66025,27 +66323,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", + "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" }, @@ -66054,17 +66352,10 @@ "isasync": false, "name": "listNetworkServiceProviders", "params": [ - { - "description": "list providers by name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -66077,18 +66368,18 @@ "type": "uuid" }, { - "description": "list providers by state", + "description": "list providers by name", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "list providers by state", "length": 255, - "name": "pagesize", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { "description": "List by keyword", @@ -66096,21 +66387,23 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addNetworkServiceProvider,listTrafficTypes", "response": [ - {}, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, { "description": "state of the network provider", "name": "state", @@ -66118,18 +66411,28 @@ }, {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -66138,14 +66441,9 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -66172,27 +66470,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 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" } ] }, @@ -66217,17 +66515,17 @@ "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": "any text associated with the success or failure", "name": "displaytext", @@ -66252,26 +66550,26 @@ ], "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": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ] }, @@ -66296,22 +66594,22 @@ "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ] }, { @@ -66338,24 +66636,19 @@ "related": "listSecondaryStorageSelectors", "response": [ { - "description": "Name of the heuristic.", - "name": "name", + "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": "The resource type directed to a specific secondary storage by the selector. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", - "name": "type", + "description": "Description of the heuristic.", + "name": "description", "type": "string" }, { @@ -66369,8 +66662,8 @@ "type": "string" }, { - "description": "Description of the heuristic.", - "name": "description", + "description": "Name of the heuristic.", + "name": "name", "type": "string" }, { @@ -66383,12 +66676,17 @@ "name": "zoneid", "type": "string" }, + {}, { "description": "ID of the heuristic.", "name": "id", "type": "string" }, - {} + { + "description": "The heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", + "type": "string" + } ], "since": "4.19.0" }, @@ -66409,23 +66707,18 @@ "related": "createUser,disableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { - "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 account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { @@ -66433,10 +66726,16 @@ "name": "iscallerchilddomain", "type": "boolean" }, + {}, + { + "description": "the account name of the user", + "name": "account", + "type": "string" + }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the api key of the user", + "name": "apikey", + "type": "string" }, { "description": "true if user has two factor authentication enabled", @@ -66444,39 +66743,49 @@ "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 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 type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "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": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the domain name of the user", + "name": "domain", + "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 lastname", - "name": "lastname", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -66485,8 +66794,8 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -66495,29 +66804,28 @@ "type": "apikeyaccess" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user ID", + "name": "id", "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 domain name of the user", - "name": "domain", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user state", + "name": "state", "type": "string" }, { @@ -66526,24 +66834,14 @@ "type": "resourceiconresponse" }, { - "description": "the api key of the user", - "name": "apikey", + "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" } ] }, @@ -66553,16 +66851,17 @@ "name": "quotaTariffCreate", "params": [ { - "description": "Quota tariff's description.", - "length": 65535, - "name": "description", + "description": "Position in the execution sequence for tariffs of the same type", + "length": 255, + "name": "position", "required": false, - "type": "string" + "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" }, @@ -66574,26 +66873,18 @@ "type": "string" }, { - "description": "The quota tariff value of the resource as per the default unit.", - "length": 255, - "name": "value", - "required": true, - "type": "double" - }, - { - "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": "Position in the execution sequence for tariffs of the same type", + "description": "The quota tariff value of the resource as per the default unit.", "length": 255, - "name": "position", - "required": false, - "since": "4.20.0.0", - "type": "integer" + "name": "value", + "required": true, + "type": "double" }, { "description": "Quota tariff's name", @@ -66608,40 +66899,51 @@ "name": "usagetype", "required": true, "type": "integer" + }, + { + "description": "Quota tariff's description.", + "length": 65535, + "name": "description", + "required": false, + "type": "string" } ], "related": "quotaTariffList", "response": [ - {}, { - "description": "description", - "name": "description", - "type": "string" + "description": "tariffValue", + "name": "tariffValue", + "type": "bigdecimal" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", - "type": "string" + "description": "the start date of the quota tariff", + "name": "effectiveDate", + "type": "date" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "name", + "name": "name", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "when the quota tariff was removed", + "name": "removed", + "type": "date" + }, + { + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { - "description": "the ID of the tariff", - "name": "id", + "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 current status of the latest async job acting on this object", @@ -66649,54 +66951,50 @@ "type": "integer" }, { - "description": "usageUnit", - "name": "usageUnit", + "description": "usage type description", + "name": "usageTypeDescription", "type": "string" }, { - "description": "name", - "name": "name", + "description": "usageName", + "name": "usageName", "type": "string" }, { - "description": "currency", - "name": "currency", + "description": "description", + "name": "description", "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", + "type": "string" }, - {}, { - "description": "tariffValue", - "name": "tariffValue", - "type": "bigdecimal" + "description": "usageDiscriminator", + "name": "usageDiscriminator", + "type": "string" }, { - "description": "when the quota tariff was removed", - "name": "removed", - "type": "date" + "description": "the ID of the tariff", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "usageType", + "name": "usageType", + "type": "int" }, + {}, { - "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": "usageName", - "name": "usageName", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -66719,43 +67017,13 @@ "related": "activateProject,createProject", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" - }, - { - "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" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "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", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the total secondary storage space (in GiB) available to be used for this project", + "name": "secondarystorageavailable", "type": "string" }, { @@ -66764,43 +67032,18 @@ "type": "string" }, { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of backups stored by this project", - "name": "backuptotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this project", - "name": "templateavailable", - "type": "string" - }, - { - "description": "the name of the project", - "name": "name", - "type": "string" - }, - { - "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" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { @@ -66808,213 +67051,242 @@ "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 name where tag belongs to", - "name": "project", + "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" }, { - "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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", + "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": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", + "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) owned by project", - "name": "secondarystoragetotal", - "type": "float" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "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 total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" }, - {}, { - "description": "the date this project was created", - "name": "created", - "type": "date" + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", + "type": "long" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the id of the project", + "name": "id", "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 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 total number of gpus available to be created for this project", + "name": "gpuavailable", "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 vpcs the project can own", - "name": "vpclimit", + "description": "the domain name where the project belongs to", + "name": "domain", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" + "description": "the total number of virtual machines available for this project to acquire", + "name": "vmavailable", + "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 project", + "name": "backuplimit", + "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the project", - "name": "backupstoragetotal", + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of gpus owned by project", + "name": "gputotal", "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", - "type": "string" + "description": "the date this project was created", + "name": "created", + "type": "date" }, { - "description": "the total number of networks available to be created for this project", - "name": "networkavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "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 total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, { "description": "the state of the project", "name": "state", "type": "string" }, { - "description": "the total volume available for this project", - "name": "volumeavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" }, - {}, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", + "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 total number of buckets stored by this project", + "name": "buckettotal", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this project", + "name": "backuptotal", + "type": "long" + }, + { + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { @@ -67023,24 +67295,40 @@ "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", - "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) available to the project", "name": "objectstorageavailable", "type": "string" }, + {}, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", - "type": "long" + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" }, { "description": "the total number of virtual machines stopped for this project", @@ -67048,9 +67336,9 @@ "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) owned by project", + "name": "primarystoragetotal", + "type": "long" }, { "description": "the total primary storage space (in GiB) available to be used for this project", @@ -67058,43 +67346,53 @@ "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", "type": "long" }, { - "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 number of networks owned by project", - "name": "networktotal", + "description": "the total backup storage space (in GiB) owned by the project", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", "type": "long" } ], @@ -67107,6 +67405,11 @@ "params": [], "related": "", "response": [ + { + "description": "the account uuid of the api remaining count", + "name": "accountid", + "type": "string" + }, { "description": "the account name of the api remaining count", "name": "account", @@ -67117,17 +67420,7 @@ "name": "apiIssued", "type": "int" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, {}, - { - "description": "currently allowed number of apis", - "name": "apiAllowed", - "type": "int" - }, { "description": "seconds left to reset counters", "name": "expireAfter", @@ -67135,14 +67428,19 @@ }, {}, { - "description": "the account uuid of the api remaining count", - "name": "accountid", - "type": "string" + "description": "currently allowed number of apis", + "name": "apiAllowed", + "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" } ] }, @@ -67172,6 +67470,7 @@ "name": "jobid", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -67181,8 +67480,7 @@ "description": "true if operation is executed successfully", "name": "success", "type": "boolean" - }, - {} + } ], "since": "3.0.0" }, @@ -67205,13 +67503,6 @@ "required": false, "type": "string" }, - { - "description": "Name of VMware datacenter to be added to specified zone.", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "The password for specified username.", "length": 255, @@ -67226,37 +67517,44 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "Name of VMware datacenter to be added to specified zone.", + "length": 255, + "name": "name", + "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 VMware Datacenter ID", - "name": "id", - "type": "string" - }, { "description": "The VMware Datacenter name", "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 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", @@ -67270,11 +67568,19 @@ "name": "updateIpv6FirewallRule", "params": [ { - "description": "the ending port of Ipv6 firewall 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": "endport", + "name": "customid", "required": false, - "type": "integer" + "since": "4.4", + "type": "string" + }, + { + "description": "the protocol for the Ipv6 firewall rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" }, { "description": "type of the ICMP message being sent", @@ -67290,13 +67596,6 @@ "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": false, - "type": "string" - }, { "description": "an optional field, whether to the display the Ipv6 firewall rule to the end user or not", "length": 255, @@ -67305,35 +67604,34 @@ "since": "4.4", "type": "boolean" }, + { + "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": "the ID of the ipv6 firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,updateIpv6FirewallRule", + "related": "updateIpv6FirewallRule,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": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "customid", + "name": "traffictype", "required": false, - "since": "4.4", "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": "the traffic type for the Ipv6 firewall rule, can be Ingress or Egress, defaulted to Ingress if not specified", + "description": "the ending port of Ipv6 firewall rule", "length": 255, - "name": "traffictype", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { "description": "the starting port of Ipv6 firewall rule", @@ -67343,37 +67641,26 @@ "type": "integer" } ], - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "response": [ - {}, - { - "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 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 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 VM display name for the port forwarding rule", - "name": "virtualmachinedisplayname", + "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", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { @@ -67382,18 +67669,24 @@ "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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 ID of the port forwarding rule", - "name": "id", + "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 ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -67401,23 +67694,28 @@ "name": "tags", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "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", + "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": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -67426,18 +67724,18 @@ "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 account associated with the tag", - "name": "account", + "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" }, { @@ -67446,48 +67744,47 @@ "type": "string" }, { - "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": "list" }, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "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 starting port of port forwarding rule's private port range", + "name": "privateport", + "type": "string" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", "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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "name": "publicendport", "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 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", @@ -67495,10 +67792,11 @@ "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" - } + }, + {} ] }, { @@ -67507,20 +67805,13 @@ "name": "updateIsoPermissions", "params": [ { - "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", "length": 255, - "name": "accounts", + "name": "projectids", + "related": "activateProject,createProject", "required": false, "type": "list" }, - { - "description": "the template ID", - "length": 255, - "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": "true for featured template/iso, false otherwise", "length": 255, @@ -67528,6 +67819,13 @@ "required": false, "type": "boolean" }, + { + "description": "a comma delimited list of accounts within caller's domain. If specified, \"op\" parameter has to be passed in.", + "length": 255, + "name": "accounts", + "required": false, + "type": "list" + }, { "description": "true for public template/iso, false for private templates/isos", "length": 255, @@ -67536,11 +67834,12 @@ "type": "boolean" }, { - "description": "permission operator (add, remove, reset)", + "description": "the template ID", "length": 255, - "name": "op", - "required": false, - "type": "string" + "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": "true if the template/iso is extractable, false other wise. Can be set only by root admin", @@ -67550,20 +67849,20 @@ "type": "boolean" }, { - "description": "a comma delimited list of projects. If specified, \"op\" parameter has to be passed in.", + "description": "permission operator (add, remove, reset)", "length": 255, - "name": "projectids", - "related": "activateProject,createProject", + "name": "op", "required": false, - "type": "list" + "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", @@ -67575,11 +67874,10 @@ "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" }, - {}, {} ] }, @@ -67598,30 +67896,30 @@ } ], "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } + ] + }, { "description": "Deletes a network ACL", "isasync": true, @@ -67637,26 +67935,26 @@ } ], "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" } ] @@ -67666,19 +67964,26 @@ "isasync": false, "name": "listASNRanges", "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": "the zone ID", @@ -67687,28 +67992,10 @@ "related": "createZone,listZones", "required": false, "type": "uuid" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "Start AS Number", "name": "startasn", @@ -67725,8 +68012,14 @@ "type": "long" }, { - "description": "ID of the AS Number Range", - "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" }, { @@ -67734,22 +68027,66 @@ "name": "created", "type": "date" }, + { + "description": "ID of the AS Number Range", + "name": "id", + "type": "string" + }, {} ], "since": "4.20.0" }, { - "description": "create Tungsten-Fabric tag", - "isasync": true, - "name": "createTungstenFabricTag", + "description": "Sends an email to the user with a token to reset the password using resetPassword command.", + "isasync": false, + "name": "forgotPassword", "params": [ { - "description": "Tungsten-Fabric tag value", + "description": "Username", "length": 255, - "name": "tagvalue", + "name": "username", "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.", + "length": 255, + "name": "domain", + "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" + }, + { + "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.20.0.0" + }, + { + "description": "create Tungsten-Fabric tag", + "isasync": true, + "name": "createTungstenFabricTag", + "params": [ { "description": "Tungsten-Fabric tag type", "length": 255, @@ -67764,46 +68101,48 @@ "related": "createZone,listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric tag value", + "length": 255, + "name": "tagvalue", + "required": true, + "type": "string" } ], "related": "listTungstenFabricTag,applyTungstenFabricTag", "response": [ - { - "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": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + {}, { - "description": "Tungsten-Fabric tag type uuid", - "name": "uuid", - "type": "string" + "description": "list Tungsten-Fabric policy", + "name": "policy", + "type": "list" }, - {}, - {}, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, + {}, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric tag name", + "name": "name", + "type": "string" }, { "description": "list Tungsten-Fabric vm", @@ -67811,14 +68150,19 @@ "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", + "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 tag type uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -67828,23 +68172,23 @@ "name": "addOpenDaylightController", "params": [ { - "description": "Credential to access the OpenDaylight API", + "description": "Api URL of the OpenDaylight Controller.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "Username to access the OpenDaylight API", + "description": "Credential to access the OpenDaylight API", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, { - "description": "Api URL of the OpenDaylight Controller.", + "description": "Username to access the OpenDaylight API", "length": 255, - "name": "url", + "name": "username", "required": true, "type": "string" }, @@ -67859,14 +68203,10 @@ ], "related": "deleteOpenDaylightController", "response": [ + {}, { - "description": "device id of the controller", - "name": "id", - "type": "string" - }, - { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the physical network to which this controller belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -67875,8 +68215,8 @@ "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "device id of the controller", + "name": "id", "type": "string" }, { @@ -67884,7 +68224,11 @@ "name": "url", "type": "string" }, - {}, + { + "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", @@ -67904,10 +68248,10 @@ "name": "createZone", "params": [ { - "description": "the second DNS for the Zone", + "description": "network type of the zone, can be Basic or Advanced", "length": 255, - "name": "dns2", - "required": false, + "name": "networktype", + "required": true, "type": "string" }, { @@ -67918,18 +68262,10 @@ "type": "string" }, { - "description": "comma separated list of storage access groups for the hosts in the zone", - "length": 255, - "name": "storageaccessgroups", - "required": false, - "since": "4.21.0", - "type": "list" - }, - { - "description": "the second internal DNS for the Zone", + "description": "the first internal DNS for the Zone", "length": 255, - "name": "internaldns2", - "required": false, + "name": "internaldns1", + "required": true, "type": "string" }, { @@ -67939,14 +68275,6 @@ "required": false, "type": "string" }, - { - "description": "true if the zone is an edge zone, false otherwise", - "length": 255, - "name": "isedge", - "required": false, - "since": "4.18.0", - "type": "boolean" - }, { "description": "the ID of the containing domain, null for public zones", "length": 255, @@ -67955,6 +68283,14 @@ "required": false, "type": "uuid" }, + { + "description": "comma separated list of storage access groups for the hosts in the zone", + "length": 255, + "name": "storageaccessgroups", + "required": false, + "since": "4.21.0", + "type": "list" + }, { "description": "the second DNS for IPv6 network in the Zone", "length": 255, @@ -67963,107 +68299,80 @@ "type": "string" }, { - "description": "Allocation state of this Zone for allocation of new resources", + "description": "the guest CIDR address for the Zone", "length": 255, - "name": "allocationstate", + "name": "guestcidraddress", "required": false, "type": "string" }, { - "description": "true if network is security group enabled, false otherwise", + "description": "the second DNS for the Zone", "length": 255, - "name": "securitygroupenabled", + "name": "dns2", + "required": false, + "type": "string" + }, + { + "description": "true if the zone is an edge zone, false otherwise", + "length": 255, + "name": "isedge", "required": false, + "since": "4.18.0", "type": "boolean" }, { - "description": "the first DNS for the Zone", + "description": "the name of the Zone", "length": 255, - "name": "dns1", + "name": "name", "required": true, "type": "string" }, { - "description": "the guest CIDR address for the Zone", + "description": "Allocation state of this Zone for allocation of new resources", "length": 255, - "name": "guestcidraddress", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "network type of the zone, can be Basic or Advanced", + "description": "true if local storage offering enabled, false otherwise", "length": 255, - "name": "networktype", - "required": true, - "type": "string" + "name": "localstorageenabled", + "required": false, + "type": "boolean" }, { - "description": "the name of the Zone", + "description": "the first DNS for the Zone", "length": 255, - "name": "name", + "name": "dns1", "required": true, "type": "string" }, { - "description": "true if local storage offering enabled, false otherwise", + "description": "true if network is security group enabled, false otherwise", "length": 255, - "name": "localstorageenabled", + "name": "securitygroupenabled", "required": false, "type": "boolean" }, { - "description": "the first internal DNS for the Zone", + "description": "the second internal DNS for the Zone", "length": 255, - "name": "internaldns1", - "required": true, + "name": "internaldns2", + "required": false, "type": "string" } ], "related": "listZones", "response": [ { - "description": "Total GPUs in the Zone", - "name": "gputotal", - "type": "long" - }, - { - "description": "Meta data associated with the zone (key/value pairs)", - "name": "resourcedetails", - "type": "map" - }, - { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" - }, - { - "description": "the UUID of the containing domain, null for public zones", - "name": "domainid", + "description": "Zone name", + "name": "name", "type": "string" }, { @@ -68072,275 +68381,310 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", "type": "integer" }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" - }, { "description": "Used GPUs in the Zone", "name": "gpuused", "type": "long" }, { - "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": "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", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "External network provider if any", - "name": "provider", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, {}, - { - "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": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", - "type": "string" - }, { "description": "the display text of the zone", "name": "displaytext", "type": "string" }, { - "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": "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 type of the zone - core or edge", - "name": "type", + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, - { - "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": "Zone description", - "name": "description", - "type": "string" - }, - { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", - "type": "string" - }, - { - "description": "AS Number Range", - "name": "asnrange", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "tag key name", - "name": "key", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "Zone name", - "name": "name", + "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", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the type of the zone - core or edge", + "name": "type", + "type": "string" + }, + { + "description": "the first DNS for the Zone", + "name": "dns1", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the Zone", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + { + "description": "AS Number Range", + "name": "asnrange", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "Allow end users to specify VR MTU", + "name": "allowuserspecifyvrmtu", + "type": "boolean" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Pod name", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" - }, - { - "description": "the Zone ID", - "name": "zoneid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the Pod ID", - "name": "podid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], - "type": "list" + "type": "set" }, { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + "description": "Total GPUs in the Zone", + "name": "gputotal", + "type": "long" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "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 maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Zone Token", + "name": "zonetoken", + "type": "string" + }, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "Zone description", + "name": "description", + "type": "string" + }, + { + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "External network provider if any", + "name": "provider", "type": "string" }, { "description": "true, if routed network/vpc is enabled", "name": "routedmodeenabled", "type": "boolean" + }, + { + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", + "type": "boolean" } ] }, @@ -68364,11 +68708,19 @@ "type": "integer" }, { - "description": "", + "description": "list children domain by parent domain ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", "required": false, - "type": "integer" + "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", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" }, { "description": "flag to display the resource icon for domains", @@ -68384,13 +68736,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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" - }, { "description": "to return the entire tree, use the value \"true\". To return the first level children, use the value \"false\".", "length": 255, @@ -68399,165 +68744,188 @@ "type": "boolean" }, { - "description": "list children domain by parent domain ID.", + "description": "", "length": 255, - "name": "id", - "related": "createDomain,listDomainChildren,listDomains,listDomains,moveDomain", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createDomain,listDomains,listDomains,moveDomain", "response": [ { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the name of the domain", - "name": "name", + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "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 domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the ID of the domain", + "name": "id", + "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total number of networks the domain can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "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 number of virtual machines deployed by this domain", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "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": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", "type": "boolean" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "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 number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, - {}, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { @@ -68566,8 +68934,13 @@ "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", + "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" }, { @@ -68576,53 +68949,43 @@ "type": "float" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", - "type": "string" + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", + "type": "long" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" - }, - { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "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 number of gpus the domain can own", - "name": "gpulimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { @@ -68631,70 +68994,66 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, + {}, { - "description": "the path of the domain", - "name": "path", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, - {}, { "description": "the total number of vpcs the domain can own", "name": "vpclimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "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 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 total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "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 available to this domain", - "name": "backupavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the path of the domain", + "name": "path", + "type": "string" }, { "description": "the total number of backups stored by this domain", @@ -68702,49 +69061,34 @@ "type": "long" }, { - "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 object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "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 primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "type": "string" }, - { - "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 total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "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" } ] }, @@ -68757,7 +69101,7 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "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", + "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,createVMFromBackup,createVMFromBackup,importUnmanagedInstance,importVm", "required": true, "type": "uuid" } @@ -68765,21 +69109,21 @@ "related": "", "response": [ {}, + { + "description": "The base64 encoded encrypted password of the VM", + "name": "encryptedpassword", + "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" } ] }, @@ -68789,12 +69133,12 @@ "name": "assignToGlobalLoadBalancerRule", "params": [ { - "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": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, - "type": "uuid" + "type": "list" }, { "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'", @@ -68804,32 +69148,32 @@ "type": "map" }, { - "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": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", "required": true, - "type": "list" + "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", "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", @@ -68842,13 +69186,6 @@ "isasync": false, "name": "addImageStoreS3", "params": [ - { - "description": "Socket timeout (milliseconds)", - "length": 255, - "name": "sockettimeout", - "required": false, - "type": "integer" - }, { "description": "Signer Algorithm to use, either S3SignerType or AWSS3V4SignerType", "length": 255, @@ -68857,67 +69194,74 @@ "type": "string" }, { - "description": "S3 secret key", + "description": "S3 endpoint", "length": 255, - "name": "secretkey", + "name": "endpoint", "required": true, "type": "string" }, { - "description": "Connection timeout (milliseconds)", + "description": "Connection TTL (milliseconds)", "length": 255, - "name": "connectiontimeout", + "name": "connectionttl", "required": false, "type": "integer" }, { - "description": "S3 endpoint", + "description": "Name of the storage bucket", "length": 255, - "name": "endpoint", + "name": "bucket", "required": true, "type": "string" }, { - "description": "Connection TTL (milliseconds)", + "description": "Connection timeout (milliseconds)", "length": 255, - "name": "connectionttl", + "name": "connectiontimeout", "required": false, "type": "integer" }, { - "description": "Maximum number of times to retry on error", + "description": "Socket timeout (milliseconds)", "length": 255, - "name": "maxerrorretry", + "name": "sockettimeout", "required": false, "type": "integer" }, { - "description": "Name of the storage bucket", + "description": "S3 access key", "length": 255, - "name": "bucket", + "name": "accesskey", "required": true, "type": "string" }, { - "description": "Use HTTPS instead of HTTP", + "description": "Whether TCP keep-alive is used", "length": 255, - "name": "usehttps", + "name": "usetcpkeepalive", "required": false, "type": "boolean" }, { - "description": "Whether TCP keep-alive is used", + "description": "Maximum number of times to retry on error", "length": 255, - "name": "usetcpkeepalive", + "name": "maxerrorretry", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "S3 access key", + "description": "S3 secret key", "length": 255, - "name": "accesskey", + "name": "secretkey", "required": true, "type": "string" + }, + { + "description": "Use HTTPS instead of HTTP", + "length": 255, + "name": "usehttps", + "required": false, + "type": "boolean" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore,listImageStores", @@ -68928,59 +69272,50 @@ "type": "string" }, { - "description": "the Zone ID of the image store", - "name": "zoneid", - "type": "string" - }, - { - "description": "the protocol of the image store", - "name": "protocol", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, - { - "description": "the total disk size of the host", - "name": "disksizetotal", - "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 name of the image store", - "name": "name", + "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 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 Zone name of the image store", + "name": "zonename", + "type": "string" }, + {}, { - "description": "the ID of the image store", - "name": "id", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -68993,7 +69328,16 @@ "name": "readonly", "type": "boolean" }, - {} + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + } ], "since": "4.7.0" }, @@ -69035,7 +69379,7 @@ "description": "(optional) the host ID to upload certificate", "length": 255, "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost,addBaremetalHost", + "related": "addBaremetalHost,declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" } @@ -69043,23 +69387,24 @@ "related": "listTemplateDirectDownloadCertificates", "response": [ { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the direct download certificate issuer", + "name": "validity", + "type": "string" }, { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", + "description": "the direct download certificate id", + "name": "id", "type": "string" }, + {}, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the direct download certificate version", + "name": "version", "type": "string" }, { - "description": "the direct download certificate issuer", - "name": "validity", + "description": "the direct download certificate subject", + "name": "subject", "type": "string" }, { @@ -69068,47 +69413,46 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the zone name where the certificate is uploaded", + "name": "zonename", + "type": "string" }, { - "description": "the direct download certificate id", - "name": "id", + "description": "the direct download certificate issuer", + "name": "issuer", "type": "string" }, { - "description": "the direct download certificate subject", - "name": "subject", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "the direct download certificate version", - "name": "version", - "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": "issuer", + "description": "the direct download certificate alias", + "name": "alias", "type": "string" - }, - {} + } ], "since": "4.11.0" }, @@ -69117,30 +69461,6 @@ "isasync": true, "name": "importUnmanagedInstance", "params": [ - { - "description": "import instance to the domain specified", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, - { - "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": "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, @@ -69148,13 +69468,6 @@ "required": true, "type": "string" }, - { - "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": "migrateallowed", - "required": false, - "type": "boolean" - }, { "description": "VM nic to network id mapping using keys nic and network", "length": 255, @@ -69163,9 +69476,9 @@ "type": "map" }, { - "description": "the display name of the instance", + "description": "the host name of the instance", "length": 255, - "name": "displayname", + "name": "hostname", "required": false, "type": "string" }, @@ -69178,18 +69491,19 @@ "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", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "forced", + "name": "datadiskofferinglist", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "the host name of the instance", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "hostname", + "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": "string" + "type": "uuid" }, { "description": "VM nic to ip address mapping using keys nic, ip4Address", @@ -69199,26 +69513,18 @@ "type": "map" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the display name of the instance", "length": 255, - "name": "account", + "name": "displayname", "required": false, "type": "string" }, { - "description": "the service offering for the virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" - }, - { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", + "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": "datadiskofferinglist", + "name": "migrateallowed", "required": false, - "type": "map" + "type": "boolean" }, { "description": "used to specify the custom parameters.", @@ -69226,203 +69532,76 @@ "name": "details", "required": false, "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 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", - "type": "string" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "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": "the cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "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": "import instance to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "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": "forced", + "required": false, "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, + "description": "the service offering for the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "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,createVMFromBackup,createVMFromBackup,importVm", + "response": [ { - "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 VM's primary IP address", - "name": "ipaddress", + "description": "Guest vm Boot Type", + "name": "boottype", "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -69431,201 +69610,78 @@ "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "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": "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", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "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", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { "description": "the cidr of IPv6 network", @@ -69633,14 +69689,14 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 ID of the corresponding network", + "name": "networkid", + "type": "string" }, { "description": "Id of the vm to which the nic belongs", @@ -69648,38 +69704,28 @@ "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "description": "the ip address of the nic", + "name": "ipaddress", "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" }, { @@ -69688,38 +69734,8 @@ "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": "the name of the corresponding network", - "name": "networkname", - "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": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -69728,14 +69744,14 @@ "type": "boolean" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "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 ID of the nic", + "name": "id", + "type": "string" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -69743,13 +69759,13 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -69758,31 +69774,213 @@ "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" } ], "type": "set" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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": "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 domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" + }, + { + "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + {}, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "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 project id of the vm", + "name": "projectid", + "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 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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + {}, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" + }, + { + "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" + }, + { + "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": "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 vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -69790,76 +69988,51 @@ "name": "securitygroup", "response": [ { - "description": "the ID of the security group", - "name": "id", + "description": "the account owning the security group", + "name": "account", "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 project name of the group", - "name": "project", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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 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 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 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", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -69868,8 +70041,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -69878,103 +70051,165 @@ "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": "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": "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": "resource type", + "name": "resourcetype", "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": "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 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", + "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" } ], "type": "set" }, { - "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 protocol of the security group rule", - "name": "protocol", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "tag key name", + "name": "key", + "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" }, { - "description": "account owning the security group rule", - "name": "account", + "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" + } + ], + "type": "set" + }, + { + "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 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" }, { @@ -69982,147 +70217,110 @@ "name": "tags", "response": [ { - "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": "the project id the tag belongs to", - "name": "projectid", + "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" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "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": "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": "customer associated with the tag", - "name": "customer", + "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": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "resource type", - "name": "resourcetype", + "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 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", - "type": "string" + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "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": "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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" }, { - "description": "tag key name", - "name": "key", + "description": "security group name", + "name": "securitygroupname", "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 number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { "description": "the name of the security group", @@ -70130,162 +70328,95 @@ "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" } ], "type": "set" }, { - "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", - "type": "string" - }, - { - "description": "the project id of the vm", - "name": "projectid", - "type": "string" - }, - {}, - { - "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 name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "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": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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", + "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": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "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": "the domain name of the affinity group", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -70294,8 +70425,8 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { @@ -70304,8 +70435,8 @@ "type": "list" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { @@ -70314,41 +70445,77 @@ "type": "list" }, { - "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 project name of the affinity group", - "name": "project", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", + "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" }, + {}, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { @@ -70357,18 +70524,43 @@ "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "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 name of the vm", - "name": "project", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { @@ -70377,14 +70569,166 @@ "type": "date" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 virtual machine", + "name": "id", + "type": "string" + }, + { + "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", + "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 backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { "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": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "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": "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": "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" } ], "since": "4.14.0" @@ -70405,12 +70749,16 @@ ], "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", @@ -70421,11 +70769,7 @@ "name": "jobstatus", "type": "integer" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ], "since": "4.21.0" }, @@ -70435,104 +70779,99 @@ "name": "createPhysicalNetwork", "params": [ { - "description": "the Zone ID for the physical network", + "description": "Tag the physical network", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "tags", + "required": false, + "type": "list" }, { - "description": "the name of the physical network", + "description": "the isolation method for the physical network[VLAN/L3/GRE]", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "isolationmethods", + "required": false, + "type": "list" }, { - "description": "the speed for the physical network[1G/10G]", + "description": "domain ID of the account owning a physical network", "length": 255, - "name": "networkspeed", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the VLAN for the physical network", + "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": "vlan", + "name": "broadcastdomainrange", "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", + "description": "the VLAN for the physical network", "length": 255, - "name": "broadcastdomainrange", + "name": "vlan", "required": false, "type": "string" }, { - "description": "the isolation method for the physical network[VLAN/L3/GRE]", + "description": "the Zone ID for the physical network", "length": 255, - "name": "isolationmethods", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "Tag the physical network", + "description": "the name of the physical network", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "name", + "required": true, + "type": "string" }, { - "description": "domain ID of the account owning a physical network", + "description": "the speed for the physical network[1G/10G]", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "networkspeed", "required": false, - "type": "uuid" + "type": "string" } ], "related": "listPhysicalNetworks,updatePhysicalNetwork", "response": [ { - "description": "comma separated tag", - "name": "tags", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "isolation methods", + "name": "isolationmethods", "type": "string" }, { - "description": "the vlan of the physical network", - "name": "vlan", + "description": "comma separated tag", + "name": "tags", "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", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "state of the physical network", + "name": "state", "type": "string" }, { - "description": "name of the physical network", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "state of the physical network", - "name": "state", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -70540,27 +70879,32 @@ "name": "networkspeed", "type": "string" }, - {}, - {}, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "zone id of the physical network", - "name": "zoneid", + "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": "name of the physical network", + "name": "name", "type": "string" }, { "description": "Broadcast domain range of the physical network", "name": "broadcastdomainrange", "type": "string" + }, + {}, + {}, + { + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" } ], "since": "3.0.0" @@ -70571,57 +70915,56 @@ "name": "listAutoScaleVmGroups", "params": [ { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the policy", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "the name of the autoscale vmgroup", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "the ID of the policy", + "description": "", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "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": "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 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,moveDomain", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "the ID of the autoscale vm group", "length": 255, - "name": "page", + "name": "id", + "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the name of the autoscale vmgroup", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", @@ -70632,102 +70975,106 @@ "type": "boolean" }, { - "description": "the ID of the autoscale vm group", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "enableAutoScaleVmGroup,listAutoScaleVmGroups", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, "type": "uuid" }, { - "description": "the availability zone ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "activateProject,createProject", "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": "", + "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": "the ID of the loadbalancer", "length": 255, "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, "type": "uuid" }, { - "description": "the ID of the profile", + "description": "the availability zone ID", "length": 255, - "name": "vmprofileid", - "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "name": "zoneid", + "related": "listZones", "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": "the ID of the profile", "length": 255, - "name": "listall", + "name": "vmprofileid", + "related": "createAutoScaleVmProfile,listAutoScaleVmProfiles,updateAutoScaleVmProfile", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "enableAutoScaleVmGroup", "response": [ - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "associatednetworkid", + "description": "the name of the guest network the lb rule belongs to", + "name": "associatednetworkname", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the private port", + "name": "privateport", + "type": "string" }, { - "description": "the domain name of the vm group", - "name": "domain", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", + "type": "int" + }, + { + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the name of the autoscale vm group ", + "name": "name", "type": "string" }, - {}, { - "description": "the private port", - "name": "privateport", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the lb provider of the guest network the lb rule belongs to", + "name": "lbprovider", "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 account owning the vm group", + "name": "account", + "type": "string" }, { "description": "the domain ID of the vm group", @@ -70735,29 +71082,24 @@ "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", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", "type": "string" }, { - "description": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "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 public ip address id", + "name": "publicipid", + "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.", @@ -70765,38 +71107,39 @@ "type": "int" }, { - "description": "the date when this vm group was created", - "name": "created", - "type": "date" + "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", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", + "description": "path of the domain to which the vm group belongs", + "name": "domainpath", "type": "string" }, { - "description": "the public port", - "name": "publicport", - "type": "string" + "description": "the frequency at which the conditions have to be evaluated", + "name": "interval", + "type": "int" }, + {}, { - "description": "the account owning the vm group", - "name": "account", + "description": "the load balancer rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", - "type": "string" + "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", + "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" }, { @@ -70804,35 +71147,36 @@ "name": "publicip", "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 vm group ID", + "name": "id", + "type": "string" + }, { "description": "the current state of the AutoScale Vm Group", "name": "state", "type": "string" }, + {}, { - "description": "the frequency at which the conditions have to be evaluated", - "name": "interval", - "type": "int" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, { "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", - "type": "string" - }, - { - "description": "the name of the autoscale vm group ", - "name": "name", - "type": "string" } ] }, @@ -70842,16 +71186,16 @@ "name": "updatePod", "params": [ { - "description": "the name of the Pod", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "name", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the starting IP address for the Pod", + "description": "the netmask of the Pod", "length": 255, - "name": "startip", + "name": "netmask", "required": false, "type": "string" }, @@ -70862,13 +71206,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 gateway for the Pod", "length": 255, @@ -70885,9 +71222,16 @@ "type": "uuid" }, { - "description": "the netmask of the Pod", + "description": "the starting IP address for the Pod", "length": 255, - "name": "netmask", + "name": "startip", + "required": false, + "type": "string" + }, + { + "description": "the name of the Pod", + "length": 255, + "name": "name", "required": false, "type": "string" } @@ -70895,13 +71239,24 @@ "related": "createPod,listPods,createManagementNetworkIpRange", "response": [ { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", + "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": "the gateway of the Pod", - "name": "gateway", + "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 allocation state of the Pod", + "name": "allocationstate", "type": "string" }, { @@ -70910,179 +71265,168 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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", - "type": "string" + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + } + ], + "type": "list" }, - {}, - {}, { "description": "comma-separated list of storage access groups for the pod", "name": "storageaccessgroups", "type": "string" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", + "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": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the name of the Pod", + "name": "name", + "type": "string" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, + { + "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 capacity currently in use", - "name": "capacityused", - "type": "long" - }, { "description": "the capacity type", "name": "type", "type": "short" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", - "type": "string" - }, - { - "description": "the Pod ID", - "name": "podid", - "type": "string" + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { "description": "the percentage of capacity currently in use", "name": "percentused", "type": "string" }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "the Zone ID", "name": "zoneid", "type": "string" }, - { - "description": "the Cluster name", - "name": "clustername", - "type": "string" - }, { "description": "the capacity name", "name": "name", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Pod name", - "name": "podname", + "description": "The tag for the capacity type", + "name": "tag", "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 gateway for the range", - "name": "gateway", - "type": "string" }, { - "description": "the starting IP for the range", - "name": "startip", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the Pod ID", + "name": "podid", "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", + "description": "the Zone name of the Pod", + "name": "zonename", "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", + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", "type": "list" } ] @@ -71092,11 +71436,19 @@ "isasync": true, "name": "attachIso", "params": [ + { + "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", + "required": true, + "type": "uuid" + }, { "description": "the ID of the virtual machine", "length": 255, "name": "virtualmachineid", - "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", + "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,createVMFromBackup,createVMFromBackup,importVm", "required": true, "type": "uuid" }, @@ -71107,117 +71459,18 @@ "required": false, "since": "4.15.1", "type": "boolean" - }, - { - "description": "the ID of the ISO file", - "length": 255, - "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" } ], - "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", + "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,createVMFromBackup,createVMFromBackup,importVm", "response": [ { - "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 total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "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": "the format of the template for the virtual machine", - "name": "templateformat", - "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": "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "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 user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, - {}, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -71231,78 +71484,8 @@ "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" - }, - { - "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": "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", - "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)", - "name": "memorytargetkbs", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "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 virtual machine", + "name": "id", "type": "string" }, { @@ -71311,93 +71494,92 @@ "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "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 user's name who deployed the virtual machine", + "name": "username", "type": "string" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 ip address of the nic", - "name": "ipaddress", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", "name": "nsxlogicalswitchport", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -71406,78 +71588,58 @@ "type": "string" }, { - "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 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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 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", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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 netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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" }, { @@ -71486,525 +71648,310 @@ "type": "list" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "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", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" + }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "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 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": "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 count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "CPU arch of the VM", + "name": "arch", + "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 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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", - "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 name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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 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": "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 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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 video RAM size in MB", - "name": "videoram", + "description": "the maximum X resolution", + "name": "maxresolutionx", "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "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": "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": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, + {}, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, + {}, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "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 vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "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": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", - "type": "long" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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": "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ { - "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", + "description": "the list of ingress rules associated with the security group", + "name": "ingressrule", "response": [ { - "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", + "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", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { - "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 ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "tag value", - "name": "value", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the protocol of the security group rule", + "name": "protocol", "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": "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", + "description": "tag value", + "name": "value", "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": "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 domain associated with the tag", + "name": "domain", "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 key name", + "name": "key", "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" }, { @@ -72013,61 +71960,36 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "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 type of the ICMP message response", - "name": "icmptype", - "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 protocol of the security group rule", - "name": "protocol", - "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" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" } ], "type": "set" }, - { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, { "description": "the list of virtualmachine ids associated with this securitygroup", "name": "virtualmachineids", @@ -72078,19 +72000,24 @@ "name": "egressrule", "response": [ { - "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 protocol of the security group rule", - "name": "protocol", + "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", + "type": "string" + }, + { + "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", @@ -72098,47 +72025,47 @@ "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", - "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": "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 starting IP of the security group rule", + "name": "startport", + "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 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": "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": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -72152,8 +72079,8 @@ "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" }, { @@ -72161,31 +72088,138 @@ "name": "resourceid", "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" + } + ], + "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 project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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" }, { - "description": "the type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "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": "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": "the domain associated with the tag", + "name": "domain", + "type": "string" } ], "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": "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 name of the security group", + "name": "name", + "type": "string" } ], "type": "set" @@ -72195,19 +72229,84 @@ "name": "isoname", "type": "string" }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { @@ -72215,25 +72314,137 @@ "name": "diskiowrite", "type": "long" }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, { "description": "List of read-only Vm details as comma separated string.", "name": "readonlydetails", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "State of the Service from LB rule", + "name": "servicestate", + "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": "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": "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "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 VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { "description": "Vm details in key/value pairs.", @@ -72241,14 +72452,91 @@ "type": "map" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "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": "tag key name", + "name": "key", + "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": "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": "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", + "type": "string" }, { "description": "the group name of the virtual machine", @@ -72256,24 +72544,80 @@ "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -72289,24 +72633,14 @@ "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", "type": "string" }, { - "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", - "name": "queryfilter", + "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", + "name": "ssl", "type": "string" }, { @@ -72315,8 +72649,8 @@ "type": "string" }, { - "description": "Check Use SSL if the external LDAP server is configured for LDAP over SSL", - "name": "ssl", + "description": "You specify a query filter here, which narrows down the users, who can be part of this domain", + "name": "queryfilter", "type": "string" }, { @@ -72330,7 +72664,17 @@ "name": "jobstatus", "type": "integer" }, - {} + { + "description": "Specify the distinguished name of a user with the search permission on the directory", + "name": "binddn", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "3.0.1" }, @@ -72340,18 +72684,12 @@ "name": "createUser", "params": [ { - "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": "account", - "required": true, - "type": "string" - }, - { - "description": "email", + "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", "length": 255, - "name": "email", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" }, { "description": "lastname", @@ -72361,24 +72699,23 @@ "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": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", "length": 255, - "name": "password", - "required": true, + "name": "timezone", + "required": false, "type": "string" }, { - "description": "Creates the user under the specified domain. Has to be accompanied with the account parameter", + "description": "Unique username.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "Unique username.", + "description": "email", "length": 255, - "name": "username", + "name": "email", "required": true, "type": "string" }, @@ -72390,10 +72727,17 @@ "type": "string" }, { - "description": "Specifies a timezone for this command. For more information on the timezone parameter, see Time Zone Format.", + "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": "timezone", - "required": false, + "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.", + "length": 255, + "name": "password", + "required": true, "type": "string" }, { @@ -72407,33 +72751,18 @@ "related": "disableUser,getUser,listUsers,lockUser", "response": [ { - "description": "the timezone user was created in", - "name": "timezone", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", + "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 account name of the user", - "name": "account", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { @@ -72447,40 +72776,45 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, - {}, { "description": "the account type of the user", "name": "accounttype", "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "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 firstname", - "name": "firstname", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -72489,58 +72823,68 @@ "type": "resourceiconresponse" }, { - "description": "the user ID", - "name": "id", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" + }, + { + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "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": "true if user has two factor authentication is mandated", "name": "is2famandated", "type": "boolean" }, + { + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the user email address", + "name": "email", "type": "string" }, { - "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" }, { - "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": "true if user has two factor authentication enabled", - "name": "is2faenabled", + "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 domain ID of the user", "name": "domainid", "type": "string" }, { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the domain name of the user", + "name": "domain", "type": "string" } ] @@ -72551,11 +72895,11 @@ "name": "addCustomAction", "params": [ { - "description": "Whether the action is enabled or not. Default is disabled.", + "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": "enabled", + "name": "parameters", "required": false, - "type": "boolean" + "type": "map" }, { "description": "Specifies the timeout in seconds to wait for the action to complete before failing. Default value is 5 seconds", @@ -72565,66 +72909,66 @@ "type": "integer" }, { - "description": "Description of the action", + "description": "Name of the action", "length": 255, - "name": "description", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "The ID of the extension to associate the action with", + "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": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", - "required": true, - "type": "uuid" + "name": "details", + "required": false, + "type": "map" }, { - "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}}", + "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": "successmessage", + "name": "errormessage", "required": false, "type": "string" }, { - "description": "Name of the action", + "description": "The ID of the extension to associate the action with", "length": 255, - "name": "name", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": true, - "type": "string" + "type": "uuid" }, { - "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}}", + "description": "Description of the action", "length": 255, - "name": "errormessage", + "name": "description", "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", + "description": "List of role types allowed for the action", "length": 255, - "name": "details", + "name": "allowedroletypes", "required": false, - "type": "map" + "type": "list" }, { - "description": "List of role types allowed for the action", + "description": "Resource type for which the action is available", "length": 255, - "name": "allowedroletypes", + "name": "resourcetype", "required": false, - "type": "list" + "type": "string" }, { - "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", + "description": "Whether the action is enabled or not. Default is disabled.", "length": 255, - "name": "parameters", + "name": "enabled", "required": false, - "type": "map" + "type": "boolean" }, { - "description": "Resource type for which the action is available", + "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": "resourcetype", + "name": "successmessage", "required": false, "type": "string" } @@ -72636,58 +72980,43 @@ "name": "parameters", "response": [ { - "description": "Whether the parameter is required or not", - "name": "required", - "type": "boolean" + "description": "Type of the parameter", + "name": "type", + "type": "string" }, { - "description": "Validation format for value of the parameter. Available for specific types", - "name": "validationformat", + "description": "Name of the parameter", + "name": "name", "type": "string" }, + { + "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": "Name of the parameter", - "name": "name", - "type": "string" - }, - { - "description": "Type of the parameter", - "name": "type", + "description": "Validation format for value of the parameter. Available for specific types", + "name": "validationformat", "type": "string" } ], "type": "list" }, { - "description": "Name of the custom action", - "name": "name", - "type": "string" - }, - { - "description": "Name of the extension that this custom action belongs to", - "name": "extensionname", + "description": "Resource type for which the action is available", + "name": "resourcetype", "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", @@ -72698,16 +73027,10 @@ "name": "jobstatus", "type": "integer" }, - {}, - { - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "Description of the custom action", @@ -72716,55 +73039,119 @@ }, {}, { - "description": "ID of the custom action", - "name": "id", + "description": "ID of the extension that this custom action belongs to", + "name": "extensionid", "type": "string" }, { - "description": "ID of the extension that this custom action belongs to", - "name": "extensionid", + "description": "Details of the custom action", + "name": "details", + "type": "map" + }, + { + "description": "Whether the custom action is enabled or not", + "name": "enabled", + "type": "boolean" + }, + { + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "description": "Message that will be used on failure during execution of the action", - "name": "errormessage", + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, + { + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" + }, + {}, + { + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", "type": "string" }, { - "description": "Resource type for which the action is available", - "name": "resourcetype", + "description": "ID of the custom action", + "name": "id", "type": "string" } ], "since": "4.21.0" }, { - "description": "Creates site to site vpn local gateway", - "isasync": true, - "name": "createVpnGateway", + "description": "Resets the password for the user using the token generated via forgotPassword command.", + "isasync": false, + "name": "resetPassword", "params": [ { - "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.", + "description": "Username", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,reserveIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": false, - "since": "4.21.0", - "type": "uuid" + "name": "username", + "required": true, + "type": "string" }, { - "description": "id of the vpc", + "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": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "domain", + "required": false, + "type": "string" + }, + { + "description": "Token generated via forgotPassword command.", + "length": 255, + "name": "token", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "New password in clear text (Default hashed to SHA256SALT).", + "length": 255, + "name": "password", + "required": true, + "type": "string" + } + ], + "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" + } + ], + "since": "4.20.0.0" + }, + { + "description": "Creates site to site vpn local gateway", + "isasync": true, + "name": "createVpnGateway", + "params": [ { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -72772,39 +73159,55 @@ "required": false, "since": "4.4", "type": "boolean" + }, + { + "description": "id of the vpc", + "length": 255, + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", + "required": true, + "type": "uuid" + }, + { + "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" } ], "related": "updateVpnGateway", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id", + "name": "projectid", "type": "string" }, - {}, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the owner", + "name": "account", "type": "string" }, { - "description": "the public IP address", - "name": "publicip", + "description": "the project name", + "name": "project", "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 name", - "name": "project", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, { @@ -72813,41 +73216,42 @@ "type": "integer" }, { - "description": "is vpn gateway for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the vpc id of this gateway", + "name": "vpcid", + "type": "string" }, { - "description": "the vpn gateway ID", - "name": "id", - "type": "string" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, + {}, { - "description": "the vpc id of this gateway", - "name": "vpcid", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the vpc name of this gateway", - "name": "vpcname", + "description": "the public IP address", + "name": "publicip", "type": "string" }, { - "description": "the owner", - "name": "account", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, - {}, { - "description": "the domain id of the owner", - "name": "domainid", - "type": "string" - } + "description": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + {} ] }, { @@ -72855,6 +73259,13 @@ "isasync": true, "name": "addResourceDetail", "params": [ + { + "description": "resource id to create the details for", + "length": 255, + "name": "resourceid", + "required": true, + "type": "string" + }, { "description": "pass false if you want this detail to be disabled for the regular user. True by default", "length": 255, @@ -72876,21 +73287,9 @@ "name": "resourcetype", "required": true, "type": "string" - }, - { - "description": "resource id to create the details for", - "length": 255, - "name": "resourceid", - "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", @@ -72907,7 +73306,12 @@ "name": "jobid", "type": "string" }, - {} + {}, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -72916,24 +73320,17 @@ "name": "listVpnUsers", "params": [ { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "projectid", + "related": "activateProject,createProject", "required": false, "type": "uuid" }, @@ -72945,26 +73342,19 @@ "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "The uuid of the Vpn user", "length": 255, - "name": "projectid", - "related": "activateProject,createProject", + "name": "id", + "related": "addVpnUser,listVpnUsers", "required": false, "type": "uuid" }, { - "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": "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.", @@ -72973,6 +73363,13 @@ "required": false, "type": "boolean" }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the username of the vpn user.", "length": 255, @@ -72981,71 +73378,78 @@ "type": "string" }, { - "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" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "addVpnUser", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, + {}, { - "description": "the project name of the vpn", - "name": "project", + "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", + "name": "state", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, - {}, { "description": "the username of the vpn user", "name": "username", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the vpn userID", - "name": "id", + "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 domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the account of the remote access vpn", + "name": "account", "type": "string" }, { - "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", - "name": "state", + "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 account of the remote access vpn", - "name": "account", + "description": "the vpn userID", + "name": "id", "type": "string" } ] @@ -73059,33 +73463,33 @@ "description": "the ID of the forwarding rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "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" } ] }, @@ -73094,6 +73498,13 @@ "isasync": false, "name": "registerUserData", "params": [ + { + "description": "an optional account for the user data. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "Name of the user data", "length": 255, @@ -73108,20 +73519,6 @@ "required": false, "type": "string" }, - { - "description": "an optional account for the user data. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "User data content", - "length": 1048576, - "name": "userdata", - "required": true, - "type": "string" - }, { "description": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", "length": 255, @@ -73137,9 +73534,21 @@ "related": "activateProject,createProject", "required": false, "type": "uuid" + }, + { + "description": "User data content", + "length": 1048576, + "name": "userdata", + "required": true, + "type": "string" } ], "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", @@ -73150,18 +73559,13 @@ "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" }, @@ -73171,18 +73575,18 @@ "name": "addRegion", "params": [ { - "description": "Id of the Region", + "description": "Region service endpoint", "length": 255, - "name": "id", + "name": "endpoint", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Region service endpoint", + "description": "Id of the Region", "length": 255, - "name": "endpoint", + "name": "id", "required": true, - "type": "string" + "type": "integer" }, { "description": "Name of the region", @@ -73194,16 +73598,9 @@ ], "related": "updateRegion", "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "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" }, { @@ -73212,9 +73609,9 @@ "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" }, { "description": "the ID of the region", @@ -73227,10 +73624,17 @@ "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 end point of the region", + "name": "endpoint", + "type": "string" + }, + {} ] }, { @@ -73238,14 +73642,6 @@ "isasync": false, "name": "generateUsageRecords", "params": [ - { - "description": "List events for the specified domain.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "Start date range for usage record query. Use yyyy-MM-dd as the date format, e.g. startDate=2009-06-01.", "length": 255, @@ -73259,30 +73655,38 @@ "name": "enddate", "required": false, "type": "date" + }, + { + "description": "List events for the specified domain.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "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", + "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": "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" }, + {}, {} ] }, @@ -73326,28 +73730,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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ], "since": "4.9.0" }, @@ -73357,26 +73761,11 @@ "name": "listAccounts", "params": [ { - "description": "list account by account name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", - "length": 255, - "name": "accounttype", - "required": false, - "type": "integer" - }, - { - "description": "list only resources belonging to the domain specified", + "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "details", "required": false, - "type": "uuid" + "type": "list" }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -73386,19 +73775,12 @@ "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 accounts by cleanuprequired attribute (values are true or false)", "length": 255, - "name": "listall", + "name": "iscleanuprequired", "required": false, "type": "boolean" }, - { - "description": "comma separated list of account details requested, value can be a list of [ all, resource, min]", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, { "description": "List accounts by the Api key access value", "length": 255, @@ -73408,19 +73790,12 @@ "type": "string" }, { - "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "flag to display the resource icon for accounts", "length": 255, @@ -73429,9 +73804,9 @@ "type": "boolean" }, { - "description": "list accounts by cleanuprequired attribute (values are true or false)", + "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": "iscleanuprequired", + "name": "listall", "required": false, "type": "boolean" }, @@ -73443,10 +73818,17 @@ "since": "4.20.0", "type": "string" }, + { + "description": "list account by account name", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -73459,33 +73841,55 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list accounts by account type. Valid account types are 1 (admin), 2 (domain-admin), and 0 (user).", + "length": 255, + "name": "accounttype", + "required": false, + "type": "integer" + }, + { + "description": "list accounts by state. Valid states are enabled, disabled, and locked.", + "length": 255, + "name": "state", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "disableAccount,enableAccount,lockAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "response": [ { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "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", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { @@ -73494,328 +73898,174 @@ "type": "integer" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "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", - "name": "taggedresources", - "type": "list" + "description": "the name of the role", + "name": "rolename", + "type": "string" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "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": "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", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" - }, - { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" - }, - { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { - "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": "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 timezone user was created in", - "name": "timezone", - "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 name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the type of the role", - "name": "roletype", - "type": "string" - }, - { - "description": "the secret key of the user", - "name": "secretkey", - "type": "string" - }, - { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, - { - "description": "the api key of the user", - "name": "apikey", - "type": "string" - }, - { - "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 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 domain ID of the user", - "name": "domainid", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", - "type": "string" - }, - { - "description": "the user lastname", - "name": "lastname", - "type": "string" - }, - { - "description": "the account name of the user", - "name": "account", - "type": "string" - }, - { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" - } - ], - "type": "list" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, - {}, { - "description": "the name of the account", - "name": "name", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "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": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the id of the account", - "name": "id", - "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": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "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", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "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 ID of the role", - "name": "roleid", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "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 primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" }, { "description": "the total number of buckets which can be stored by this account", @@ -73823,13 +74073,8 @@ "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { @@ -73838,365 +74083,346 @@ "type": "long" }, { - "description": "the state of the account", - "name": "state", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "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 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 number of projects the account can own", - "name": "projectlimit", + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, + {}, + {}, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of templates which can be created by this account", - "name": "templatelimit", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "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) owned by account", - "name": "memorytotal", - "type": "long" + "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) the account can own", - "name": "objectstoragelimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", - "type": "long" - }, - { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "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", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", + "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 state of the account", + "name": "state", + "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "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 number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" - } - ] - }, - { - "description": "Destroys a router.", - "isasync": true, - "name": "destroyRouter", - "params": [ - { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "required": true, - "type": "uuid" - } - ], - "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", - "response": [ - { - "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 total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "CPU arch of the router", - "name": "arch", - "type": "string" - }, - { - "description": "the domain ID associated with the router", - "name": "domainid", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "path of the Domain the router 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 name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the template name for the router", - "name": "templatename", - "type": "string" - }, - {}, - { - "description": "the name of the router", - "name": "name", - "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": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "description": "the first DNS for the router", - "name": "dns1", - "type": "string" - }, - { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "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 total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "Last executed health check result for the router", - "name": "healthcheckresults", + "description": "the list of users associated with account", + "name": "user", "response": [ { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "result of the health check", - "name": "success", + "description": "the secret key of the user", + "name": "secretkey", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "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 date this VPC was created", - "name": "lastupdated", + "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 api key of the user", + "name": "apikey", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the type of the role", + "name": "roletype", + "type": "string" + }, + { + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the user lastname", + "name": "lastname", + "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", + "type": "apikeyaccess" + }, + { + "description": "the date and time the user account was created", + "name": "created", "type": "date" }, { - "description": "detailed response generated on running health check", - "name": "details", + "description": "the user firstname", + "name": "firstname", + "type": "string" + }, + { + "description": "the user ID", + "name": "id", + "type": "string" + }, + { + "description": "the user name", + "name": "username", + "type": "string" + }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the domain ID of the user", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain name of the user", + "name": "domain", + "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 account name of the user", + "name": "account", "type": "string" } ], "type": "list" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", + "type": "string" + } + ] + }, + { + "description": "Destroys a router.", + "isasync": true, + "name": "destroyRouter", + "params": [ + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "destroyRouter,listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "required": true, + "type": "uuid" + } + ], + "related": "listRouters,rebootRouter,stopRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", + "response": [ + { + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { @@ -74205,13 +74431,13 @@ "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -74219,34 +74445,24 @@ "name": "nic", "response": [ { - "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 ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "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": "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", @@ -74254,8 +74470,13 @@ "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -74264,19 +74485,19 @@ "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 gateway of the nic", - "name": "gateway", + "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 type of the nic", + "name": "type", + "type": "string" }, { "description": "public IP address associated with this nic via Static nat rule", @@ -74284,18 +74505,13 @@ "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -74303,24 +74519,34 @@ "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": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, { "description": "the gateway of IPv6 network", "name": "ip6gateway", "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" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -74328,82 +74554,189 @@ "name": "adaptertype", "type": "string" }, + { + "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": "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 ip address of the nic", - "name": "ipaddress", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { "description": "the broadcast uri of the nic", "name": "broadcasturi", "type": "string" + } + ], + "type": "set" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", + "response": [ + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" } ], - "type": "set" + "type": "list" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, + { + "description": "the host ID for the router", + "name": "hostid", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, { "description": "the version of scripts", "name": "scriptsversion", "type": "string" }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, { "description": "the guest MAC address for the router", "name": "guestmacaddress", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { @@ -74412,68 +74745,144 @@ "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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 name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the gateway for the router", + "name": "gateway", + "type": "string" }, { "description": "the public MAC address for the router", "name": "publicmacaddress", "type": "string" }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "type": "string" + }, + { + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, { "description": "the id of the router", "name": "id", "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "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": "the template ID for the router", - "name": "templateid", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + {}, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "CPU arch of the router", + "name": "arch", "type": "string" } ] @@ -74484,18 +74893,19 @@ "name": "listImageStores", "params": [ { - "description": "the image store protocol", + "description": "the name of the image store", "length": 255, - "name": "protocol", + "name": "name", "required": false, "type": "string" }, { - "description": "the image store provider", + "description": "the Zone ID for the image store", "length": 255, - "name": "provider", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -74504,13 +74914,6 @@ "required": false, "type": "integer" }, - { - "description": "the name of the image store", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -74519,11 +74922,11 @@ "type": "string" }, { - "description": "", + "description": "the image store provider", "length": 255, - "name": "pagesize", + "name": "provider", "required": false, - "type": "integer" + "type": "string" }, { "description": "read-only status of the image store", @@ -74543,20 +74946,31 @@ "type": "uuid" }, { - "description": "the Zone ID for the image store", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "the image store protocol", + "length": 255, + "name": "protocol", + "required": false, + "type": "string" } ], "related": "addSecondaryStorage,addSwift,listSwifts,addImageStore", "response": [ { - "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 host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { "description": "the provider name of the image store", @@ -74564,24 +74978,29 @@ "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the protocol of the image store", - "name": "protocol", + "description": "the ID of the image store", + "name": "id", "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 protocol of the image store", + "name": "protocol", "type": "string" }, { @@ -74590,9 +75009,9 @@ "type": "boolean" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the scope of the image store", + "name": "scope", + "type": "scopetype" }, { "description": "the url of the image store", @@ -74600,31 +75019,21 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, + {}, { - "description": "the Zone name of the image store", - "name": "zonename", + "description": "the Zone ID of the image store", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the name of the image store", + "name": "name", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - {} + } ], "since": "4.2.0" }, @@ -74643,16 +75052,6 @@ } ], "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": "true if operation is executed successfully", "name": "success", @@ -74664,6 +75063,16 @@ "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" + }, {} ] }, @@ -74683,67 +75092,67 @@ ], "related": "enableOutOfBandManagementForHost,configureOutOfBandManagement,changeOutOfBandManagementPassword", "response": [ + {}, { - "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 out-of-band management interface username", + "name": "username", "type": "string" }, { - "description": "the operation result description", - "name": "description", + "description": "the out-of-band management interface password", + "name": "password", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, - { - "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 out-of-band management interface address", - "name": "address", + "description": "the out-of-band management interface port", + "name": "port", "type": "string" }, {}, + { + "description": "the operation result description", + "name": "description", + "type": "string" + }, + { + "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" }, { - "description": "the out-of-band management interface username", - "name": "username", + "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 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 ID of the host", + "name": "hostid", "type": "string" }, { - "description": "the out-of-band management action (if issued)", - "name": "action", - "type": "string" + "description": "the operation result", + "name": "status", + "type": "boolean" }, { "description": "true if out-of-band management is enabled for the host", @@ -74770,196 +75179,248 @@ "related": "createProject", "response": [ { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "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 primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of virtual machines available for this project to acquire", - "name": "vmavailable", + "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", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the domain name where the project belongs to", - "name": "domain", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by project", - "name": "primarystoragetotal", + "description": "the name of the project", + "name": "name", + "type": "string" + }, + { + "description": "the domain id the project belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines stopped for this project", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the date this project was created", + "name": "created", + "type": "date" + }, + { + "description": "the total number of cpu cores owned by project", + "name": "cputotal", "type": "long" }, { - "description": "the account name of the project's owners", - "name": "owner", + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the total volume being used by this project", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", + "type": "string" + }, + { + "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) available to be used for this project", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" + }, + { + "description": "the total number of templates which have been created by this project", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total number of templates available to be created by this project", + "name": "templateavailable", + "type": "string" + }, + { + "description": "the total volume available for this project", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the project", + "name": "taggedresources", "type": "list" }, + { + "description": "the total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "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", + "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": "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "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": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the total number of cpu cores available to be created for this project", - "name": "cpuavailable", + "description": "the total number of vpcs the project can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by project", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total number of templates which can be created by this project", - "name": "templatelimit", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", - "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", - "name": "volumeavailable", - "type": "string" - }, - { - "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": "the total number of buckets available to this project", + "name": "bucketavailable", + "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 total backup storage space (in GiB) owned by the project", "name": "backupstoragetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the project", - "name": "objectstoragetotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, + {}, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", - "type": "string" - }, - { - "description": "the total number of networks the project can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the total object storage space (in GiB) available to the project", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the name of the project", - "name": "name", + "description": "the total number of templates which can be created by this project", + "name": "templatelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the project can own", - "name": "backupstoragelimit", - "type": "string" + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" }, + {}, { - "description": "the total number of cpu cores owned by project", - "name": "cputotal", - "type": "long" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { "description": "the total number of gpus owned by project", @@ -74967,43 +75428,38 @@ "type": "long" }, { - "description": "the total primary storage space (in GiB) available to be used for this project", - "name": "primarystorageavailable", + "description": "the total number of networks available to be created for this project", + "name": "networkavailable", "type": "string" }, { - "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", + "description": "the total secondary storage space (in GiB) the project can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the domain id the project belongs to", - "name": "domainid", + "description": "the total number of public ip addresses available for this project to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total memory (in MB) the project can own", - "name": "memorylimit", + "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", + "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 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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -75012,100 +75468,64 @@ "type": "string" }, { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" - }, - { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", - "type": "string" - }, - { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" }, { - "description": "the total number of backups which can be stored by this project", - "name": "backuplimit", + "description": "the total number of networks the project can own", + "name": "networklimit", "type": "string" }, - {}, { - "description": "the total number of buckets available to this project", - "name": "bucketavailable", + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of snapshots stored by this project", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", - "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", + "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", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) available to the project", - "name": "objectstorageavailable", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "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" }, { - "description": "the total volume being used by this project", - "name": "volumetotal", - "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", + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "the displaytext of the project", + "name": "displaytext", "type": "string" }, { - "description": "the id of the project", - "name": "id", + "description": "the total number of backups available to this project", + "name": "backupavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the project can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" }, { "description": "the total number of virtual machines running for this project", @@ -75113,40 +75533,29 @@ "type": "integer" }, { - "description": "the displaytext of the project", - "name": "displaytext", - "type": "string" - }, - { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", + "description": "the total primary storage space (in GiB) owned by project", + "name": "primarystoragetotal", "type": "long" }, { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" + "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 project", - "name": "networktotal", + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses available for this project to acquire", - "name": "ipavailable", + "description": "the total volume which can be used by this project", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "description": "the state of the project", + "name": "state", "type": "string" - }, - { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "type": "long" } ], "since": "3.0.0" @@ -75166,11 +75575,15 @@ } ], "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" }, { @@ -75178,14 +75591,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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" } ] @@ -75202,13 +75611,6 @@ "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, @@ -75216,35 +75618,38 @@ "related": "listManagementServers", "required": true, "type": "uuid" + }, + { + "description": "Force management server to maintenance after the maintenance window timeout, default is false", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" } ], "related": "prepareForShutdown,cancelShutdown,readyForShutdown", "response": [ { - "description": "the state of the management server", - "name": "state", - "type": "state" + "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 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 of the management server", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "The number of jobs in progress", - "name": "pendingjobscount", - "type": "long" + "description": "the state of the management server", + "name": "state", + "type": "state" }, { "description": "Indicates whether a shutdown has been triggered", @@ -75257,20 +75662,24 @@ "type": "boolean" }, { - "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": "The id of the management server", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "The number of host agents this management server is responsible for", - "name": "agentscount", - "type": "long" + "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" } ], "since": "4.21.0" @@ -75281,37 +75690,41 @@ "name": "deleteAlerts", "params": [ { - "description": "the IDs of the alerts", + "description": "delete by alert type", "length": 255, - "name": "ids", - "related": "listAlerts,listAlertTypes", + "name": "type", "required": false, - "type": "list" + "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" }, { - "description": "delete by alert type", + "description": "the IDs of the alerts", "length": 255, - "name": "type", + "name": "ids", + "related": "listAlerts,listAlertTypes", "required": false, - "type": "string" + "type": "list" }, { - "description": "start date range to delete alerts (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", + "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": "startdate", + "name": "enddate", "required": false, "type": "date" } ], "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", @@ -75323,11 +75736,7 @@ "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", @@ -75340,6 +75749,29 @@ "isasync": true, "name": "createAutoScaleVmProfile", "params": [ + { + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" + }, + { + "description": "used to specify the parameters values for the variables in userdata.", + "length": 255, + "name": "userdatadetails", + "required": false, + "since": "4.18.1", + "type": "map" + }, + { + "description": "account that will own the autoscale VM profile", + "length": 255, + "name": "account", + "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, @@ -75357,19 +75789,28 @@ "type": "uuid" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "availability zone for the auto deployed virtual machine", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is expunged", + "description": "an optional project for the autoscale VM profile", "length": 255, - "name": "expungevmgraceperiod", + "name": "projectid", + "related": "createProject", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "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", @@ -75381,12 +75822,11 @@ "type": "uuid" }, { - "description": "availability zone for 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": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "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\".", @@ -75396,65 +75836,60 @@ "type": "map" }, { - "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "description": "the time allowed for existing connections to get closed before a vm is expunged", "length": 255, - "name": "counterparam", + "name": "expungevmgraceperiod", "required": false, - "type": "map" - }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "type": "integer" }, { - "description": "account that will own the autoscale VM profile", + "description": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "account", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "the template of the auto deployed 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", + "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" + } + ], + "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", + "response": [ + { + "description": "the time allowed for existing connections to get closed before a vm is destroyed", + "name": "expungevmgraceperiod", + "type": "integer" }, + {}, { - "description": "an optional project for the autoscale VM profile", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "an optional field, whether to the display the profile to the end user or not", - "length": 255, + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "is profile for display to the regular user", "name": "fordisplay", - "required": false, - "since": "4.4", "type": "boolean" }, { - "description": "used to specify the parameters values for the variables in userdata.", - "length": 255, - "name": "userdatadetails", - "required": false, - "since": "4.18.1", - "type": "map" - } - ], - "related": "listAutoScaleVmProfiles,updateAutoScaleVmProfile", - "response": [ + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", + "type": "string" + }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "Base64 encoded VM user data", + "name": "userdata", "type": "string" }, {}, @@ -75464,8 +75899,8 @@ "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -75473,71 +75908,45 @@ "name": "domainid", "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": "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 name of the vm profile", "name": "project", "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": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" }, { "description": "the service offering to be used while deploying a virtual machine", "name": "serviceofferingid", "type": "string" }, - {}, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" - }, - { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { @@ -75545,22 +75954,22 @@ "name": "account", "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 time allowed for existing connections to get closed before a vm is destroyed", - "name": "expungevmgraceperiod", - "type": "integer" - }, { "description": "the ID of the user used to launch and destroy the VMs", "name": "autoscaleuserid", "type": "string" }, - {} + { + "description": "the template to be used while deploying a virtual machine", + "name": "templateid", + "type": "string" + } ] }, { @@ -75568,6 +75977,13 @@ "isasync": false, "name": "registerOauthProvider", "params": [ + { + "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", + "length": 255, + "name": "details", + "required": false, + "type": "map" + }, { "description": "Client ID pre-registered in the specific OAuth provider", "length": 255, @@ -75576,16 +75992,16 @@ "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "Name of the provider from the list of OAuth providers supported in CloudStack", "length": 255, - "name": "secretkey", + "name": "provider", "required": true, "type": "string" }, { - "description": "Name of the provider from the list of OAuth providers supported in CloudStack", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "provider", + "name": "redirecturi", "required": true, "type": "string" }, @@ -75597,27 +76013,15 @@ "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "redirecturi", + "name": "secretkey", "required": true, "type": "string" - }, - { - "description": "Any OAuth provider details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].clientsecret=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", - "length": 255, - "name": "details", - "required": false, - "type": "map" } ], "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", @@ -75628,313 +76032,318 @@ "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.19.0" }, { - "description": "Lists load balancer stickiness policies.", + "description": "Updates an existing GPU device", "isasync": false, - "name": "listLBStickinessPolicies", + "name": "updateGpuDevice", "params": [ { - "description": "the ID of the load balancer rule", + "description": "New GPU card ID", "length": 255, - "name": "lbruleid", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "gpucardid", + "related": "listGpuCards", "required": false, "type": "uuid" }, { - "description": "", + "description": "ID of the GPU device to update", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "required": true, + "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "New parent GPU device ID (for virtual GPU devices)", "length": 255, - "name": "fordisplay", + "name": "parentgpudeviceid", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "List by keyword", + "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", "length": 255, - "name": "keyword", + "name": "type", "required": false, "type": "string" }, { - "description": "", + "description": "New NUMA node of the GPU device", "length": 255, - "name": "pagesize", + "name": "numanode", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the load balancer stickiness policy", + "description": "New vGPU profile ID", "length": 255, - "name": "id", - "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", "required": false, "type": "uuid" } ], - "related": "createLBStickinessPolicy,updateLBStickinessPolicy", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "the state of the policy", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", "type": "string" }, + {}, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", "type": "string" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, - {}, { - "description": "the list of stickinesspolicies", - "name": "stickinesspolicy", - "response": [ - { - "description": "the params of the policy", - "name": "params", - "type": "map" - }, - { - "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 description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", - "type": "string" - }, - { - "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 host name where the GPU device is attached", + "name": "hostname", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the LB rule ID", - "name": "lbruleid", + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" + }, + { + "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 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 id of the zone the Stickiness policy belongs to", - "name": "zoneid", + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the account of the Stickiness policy", - "name": "account", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {} ], - "since": "3.0.0" + "since": "4.21.0" }, { - "description": "Updates an existing GPU device", + "description": "Lists load balancer stickiness policies.", "isasync": false, - "name": "updateGpuDevice", + "name": "listLBStickinessPolicies", "params": [ { - "description": "New vGPU profile ID", + "description": "", "length": 255, - "name": "vgpuprofileid", - "related": "createVgpuProfile,updateVgpuProfile", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "New GPU card ID", + "description": "List by keyword", "length": 255, - "name": "gpucardid", - "related": "listGpuCards", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "New NUMA node of the GPU device", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "numanode", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { - "description": "ID of the GPU device to update", + "description": "the ID of the load balancer stickiness policy", "length": 255, "name": "id", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", - "required": true, + "related": "createLBStickinessPolicy,listLBStickinessPolicies,updateLBStickinessPolicy", + "required": false, "type": "uuid" }, { - "description": "New type of GPU device (PCI, MDEV, VGPUOnly)", + "description": "the ID of the load balancer rule", "length": 255, - "name": "type", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "New parent GPU device ID (for virtual GPU devices)", + "description": "", "length": 255, - "name": "parentgpudeviceid", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice,updateGpuDevice", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "related": "createLBStickinessPolicy,updateLBStickinessPolicy", "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", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - {}, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { - "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", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "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 list of stickinesspolicies", + "name": "stickinesspolicy", + "response": [ + { + "description": "the description of the Stickiness policy", + "name": "description", + "type": "string" + }, + { + "description": "the state of the policy", + "name": "state", + "type": "string" + }, + { + "description": "the LB Stickiness policy ID", + "name": "id", + "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" + }, + { + "description": "the params of the policy", + "name": "params", + "type": "map" + }, + { + "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 vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the account of the Stickiness policy", + "name": "account", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the domain of the Stickiness policy", + "name": "domain", "type": "string" }, + {}, { - "description": "the host ID where the GPU device is attached", - "name": "hostid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the id of the zone the Stickiness policy belongs to", + "name": "zoneid", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ], - "since": "4.21.0" + "since": "3.0.0" }, { "description": "Adds a Ucs manager", @@ -75942,24 +76351,25 @@ "name": "addUcsManager", "params": [ { - "description": "the password of UCS", + "description": "the Zone id for the ucs manager", "length": 255, - "name": "password", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "the name of UCS manager", + "description": "the username of UCS", "length": 255, - "name": "name", - "required": false, + "name": "username", + "required": true, "type": "string" }, { - "description": "the username of UCS", + "description": "the name of UCS manager", "length": 255, - "name": "username", - "required": true, + "name": "name", + "required": false, "type": "string" }, { @@ -75970,26 +76380,15 @@ "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" } ], "related": "listUcsManagers", "response": [ - { - "description": "the zone ID of ucs manager", - "name": "zoneid", - "type": "string" - }, - { - "description": "the url of ucs manager", - "name": "url", - "type": "string" - }, {}, { "description": "the UUID of the latest async job acting on this object", @@ -76001,17 +76400,27 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the zone ID of ucs manager", + "name": "zoneid", + "type": "string" + }, { "description": "the ID of the ucs manager", "name": "id", "type": "string" }, + { + "description": "the url of ucs manager", + "name": "url", + "type": "string" + }, + {}, { "description": "the name of ucs manager", "name": "name", "type": "string" - }, - {} + } ] }, { @@ -76019,14 +76428,6 @@ "isasync": true, "name": "deleteVnfTemplate", "params": [ - { - "description": "Necessary if the template's type is system.", - "length": 255, - "name": "issystem", - "required": false, - "since": "4.20.0", - "type": "boolean" - }, { "description": "the ID of zone of the template", "length": 255, @@ -76035,11 +76436,19 @@ "required": false, "type": "uuid" }, + { + "description": "Necessary if the template's type is system.", + "length": 255, + "name": "issystem", + "required": false, + "since": "4.20.0", + "type": "boolean" + }, { "description": "the ID of the template", "length": 255, "name": "id", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "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" }, @@ -76053,27 +76462,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": "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" } ], "since": "4.19.0" @@ -76084,18 +76493,19 @@ "name": "listNetscalerLoadBalancers", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "netscaler load balancer device ID", "length": 255, - "name": "pagesize", + "name": "lbdeviceid", + "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,listNetscalerLoadBalancers,registerNetscalerControlCenter,deployNetscalerVpx", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -76105,110 +76515,109 @@ "type": "integer" }, { - "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" }, { - "description": "the Physical Network ID", + "description": "List by keyword", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "addNetscalerLoadBalancer,configureNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "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": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, + {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" + "description": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "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": "device name", - "name": "lbdevicename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "the public interface of the load balancer", - "name": "publicinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, - {}, { "description": "the management IP address of the external load balancer", "name": "ipaddress", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the private interface of the load balancer", - "name": "privateinterface", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, + {}, { "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" + "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" } ] }, @@ -76225,6 +76634,13 @@ "required": false, "type": "uuid" }, + { + "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 name of the instance group", "length": 255, @@ -76239,25 +76655,13 @@ "related": "createProject", "required": false, "type": "uuid" - }, - { - "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" } ], "related": "updateInstanceGroup", "response": [ { - "description": "the project name of the instance group", - "name": "project", - "type": "string" - }, - { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { @@ -76266,15 +76670,19 @@ "type": "date" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", + "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 instance group", + "name": "name", + "type": "string" + }, + { + "description": "the project ID of the instance group", + "name": "projectid", + "type": "string" }, { "description": "the ID of the instance group", @@ -76287,31 +76695,32 @@ "type": "boolean" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, + {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the project name of the instance group", + "name": "project", "type": "string" }, { - "description": "the name of the instance group", - "name": "name", + "description": "the domain name of the instance group", + "name": "domain", "type": "string" }, - {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" - } + }, + {} ] }, { @@ -76327,27 +76736,11 @@ "type": "string" }, { - "description": "The guest network the load balancer will be created for", - "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "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" - }, - { - "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": "string" + "type": "integer" }, { "description": "name of the load balancer", @@ -76364,24 +76757,24 @@ "type": "integer" }, { - "description": "the network id of the source ip address", + "description": "load balancer algorithm (source, roundrobin, leastconn)", "length": 255, - "name": "sourceipaddressnetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "algorithm", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the source port the network traffic will be load balanced from", + "description": "the network id of the source ip address", "length": 255, - "name": "sourceport", + "name": "sourceipaddressnetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": true, - "type": "integer" + "type": "uuid" }, { - "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" }, @@ -76391,45 +76784,30 @@ "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", + "description": "The guest network the load balancer will be created for", + "length": 255, "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" + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": true, + "type": "uuid" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", - "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" + } + ], + "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 Load Balancer ID", @@ -76441,34 +76819,13 @@ "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": "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": "tag value", - "name": "value", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -76477,28 +76834,28 @@ "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": "resource type", - "name": "resourcetype", + "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" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -76507,40 +76864,31 @@ "type": "string" }, { - "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": "tag key name", + "name": "key", "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": "list" }, - { - "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 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", + "description": "the ip address of the instance", + "name": "ipaddress", "type": "string" }, { @@ -76549,32 +76897,48 @@ "type": "string" }, { - "description": "the instance ID", - "name": "id", + "description": "the state of the instance", + "name": "state", "type": "string" }, { - "description": "the ip address of the instance", - "name": "ipaddress", + "description": "the instance ID", + "name": "id", "type": "string" } ], "type": "list" }, + { + "description": "the project id of the Load Balancer", + "name": "projectid", + "type": "string" + }, + { + "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 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 load balancer rule", "name": "state", "type": "string" }, + { + "description": "source port of the load balancer rule", + "name": "sourceport", + "type": "integer" + }, { "description": "instance port of the load balancer rule", "name": "instanceport", @@ -76583,10 +76947,55 @@ ], "type": "list" }, + { + "description": "Load Balancer network id", + "name": "networkid", + "type": "string" + }, + { + "description": "the description of the Load Balancer", + "name": "description", + "type": "string" + }, + { + "description": "Load Balancer source ip network id", + "name": "sourceipaddressnetworkid", + "type": "string" + }, + { + "description": "the name of the Load Balancer", + "name": "name", + "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", + "type": "string" + }, + { + "description": "Load Balancer source ip", + "name": "sourceipaddress", + "type": "string" + }, { "description": "the account of the Load Balancer", "name": "account", "type": "string" + }, + { + "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" } ], "since": "4.2.0" @@ -76596,6 +77005,14 @@ "isasync": false, "name": "updateBackupSchedule", "params": [ + { + "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": "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, @@ -76604,19 +77021,19 @@ "type": "string" }, { - "description": "ID of the VM for which schedule is to be defined", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "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,createVMFromBackup,deployVnfAppliance,deployVnfAppliance,listVnfAppliances,listVnfAppliances,importVm", + "name": "timezone", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", + "description": "ID of the VM for which schedule is to be defined", "length": 255, - "name": "intervaltype", + "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,createVMFromBackup,createVMFromBackup,importVm", "required": true, - "type": "string" + "type": "uuid" }, { "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.", @@ -76627,17 +77044,9 @@ "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.", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY", "length": 255, - "name": "timezone", + "name": "intervaltype", "required": true, "type": "string" } @@ -76645,29 +77054,35 @@ "related": "", "response": [ { - "description": "domain name", - "name": "domain", + "description": "backup protected (virtual) size in bytes", + "name": "virtualsize", + "type": "long" + }, + { + "description": "ID of the VM backup", + "name": "id", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { - "description": "backup size in bytes", - "name": "size", - "type": "long" + "description": "The backup offering corresponding to this backup was removed from the VM", + "name": "vmbackupofferingremoved", + "type": "boolean" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "description for the backup", + "name": "description", + "type": "string" }, { - "description": "backup status", - "name": "status", - "type": "status" + "description": "domain name", + "name": "domain", + "type": "string" }, { "description": "name of the backup", @@ -76675,68 +77090,64 @@ "type": "string" }, { - "description": "backup date", - "name": "created", - "type": "date" - }, - { - "description": "ID of the VM backup", - "name": "id", + "description": "zone name", + "name": "zone", "type": "string" }, { - "description": "Lists the vm specific details for the backup", - "name": "vmdetails", - "type": "map" + "description": "backup type", + "name": "type", + "type": "string" }, { - "description": "The backup offering corresponding to this backup was removed from the VM", - "name": "vmbackupofferingremoved", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, + {}, { - "description": "backup offering name", - "name": "backupofferingname", + "description": "external backup id", + "name": "externalid", "type": "string" }, { - "description": "backup protected (virtual) size in bytes", - "name": "virtualsize", + "description": "backup size in bytes", + "name": "size", "type": "long" }, { - "description": "backup offering id", - "name": "backupofferingid", + "description": "backup offering name", + "name": "backupofferingname", "type": "string" }, { - "description": "description for the backup", - "name": "description", + "description": "Interval type of the backup", + "name": "intervaltype", "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": "Interval type of the backup", - "name": "intervaltype", - "type": "string" + "description": "backup date", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Lists the vm specific details for the backup", + "name": "vmdetails", + "type": "map" }, { - "description": "zone name", - "name": "zone", + "description": "account id", + "name": "accountid", "type": "string" }, { - "description": "account id", - "name": "accountid", + "description": "account name", + "name": "account", "type": "string" }, { @@ -76745,30 +77156,33 @@ "type": "string" }, { - "description": "external backup id", - "name": "externalid", - "type": "string" + "description": "backup status", + "name": "status", + "type": "status" }, { - "description": "backup type", - "name": "type", + "description": "Indicates whether the VM from which the backup was taken is expunged or not", + "name": "isbackupvmexpunged", + "type": "boolean" + }, + { + "description": "backed up volumes", + "name": "volumes", "type": "string" }, { - "description": "zone id", - "name": "zoneid", + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { - "description": "ID of the VM", - "name": "virtualmachineid", + "description": "zone id", + "name": "zoneid", "type": "string" }, - {}, - {}, { - "description": "backed up volumes", - "name": "volumes", + "description": "backup offering id", + "name": "backupofferingid", "type": "string" } ], @@ -76780,16 +77194,9 @@ "name": "addPaloAltoFirewall", "params": [ { - "description": "Credentials to reach Palo Alto firewall device", - "length": 255, - "name": "password", - "required": true, - "type": "string" - }, - { - "description": "supports only PaloAltoFirewall", + "description": "URL of the Palo Alto appliance.", "length": 255, - "name": "networkdevicetype", + "name": "url", "required": true, "type": "string" }, @@ -76802,9 +77209,9 @@ "type": "uuid" }, { - "description": "URL of the Palo Alto appliance.", + "description": "Credentials to reach Palo Alto firewall device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, @@ -76814,43 +77221,46 @@ "name": "username", "required": true, "type": "string" + }, + { + "description": "supports only PaloAltoFirewall", + "length": 255, + "name": "networkdevicetype", + "required": true, + "type": "string" } ], "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "response": [ { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the public security zone of the external firewall", + "name": "publiczone", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", - "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": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" - }, - { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -76859,55 +77269,59 @@ "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "device state", + "name": "fwdevicestate", "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 physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the public security zone of the external firewall", - "name": "publiczone", + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" + }, + { + "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 private interface of the external firewall", + "name": "privateinterface", "type": "string" }, {}, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the private security zone of the external firewall", + "name": "privatezone", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "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" } ] @@ -76918,27 +77332,33 @@ "name": "createPrivateGateway", "params": [ { - "description": "the Physical Network ID the network belongs to", + "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the uuid of the network offering to use for the private gateways network connection", + "description": "the netmask of the Private gateway", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "netmask", + "required": true, + "type": "string" + }, + { + "description": "the ID of the network ACL", + "length": 255, + "name": "aclid", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, "type": "uuid" }, { - "description": "the IP address of the Private gateaway", + "description": "when true bypasses VLAN id/range overlap check during private gateway creation", "length": 255, - "name": "ipaddress", - "required": true, - "type": "string" + "name": "bypassvlanoverlapcheck", + "required": false, + "type": "boolean" }, { "description": "the VPC network belongs to", @@ -76949,104 +77369,78 @@ "type": "uuid" }, { - "description": "source NAT supported value. Default value false. If 'true' source NAT is enabled on the private gateway 'false': sourcenat is not supported", - "length": 255, - "name": "sourcenatsupported", - "required": false, - "type": "boolean" - }, - { - "description": "the gateway of the Private gateway", + "description": "the IP address of the Private gateaway", "length": 255, - "name": "gateway", + "name": "ipaddress", "required": true, "type": "string" }, { - "description": "the netmask of the Private gateway", + "description": "the network implementation uri for the private gateway", "length": 255, - "name": "netmask", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { - "description": "The isolated network this private gateway is associated to.", + "description": "the Physical Network ID the network belongs to", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "since": "4.17.0", "type": "uuid" }, { - "description": "the ID of the network ACL", + "description": "The isolated network this private gateway is associated to.", "length": 255, - "name": "aclid", - "related": "createNetworkACLList,listNetworkACLLists", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, + "since": "4.17.0", "type": "uuid" }, { - "description": "the network implementation uri for the private gateway", + "description": "the gateway of the Private gateway", "length": 255, - "name": "vlan", - "required": false, + "name": "gateway", + "required": true, "type": "string" }, { - "description": "when true bypasses VLAN id/range overlap check during private gateway creation", + "description": "the uuid of the network offering to use for the private gateways network connection", "length": 255, - "name": "bypassvlanoverlapcheck", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "boolean" + "type": "uuid" } ], "related": "createPrivateGateway,listPrivateGateways", "response": [ + {}, { - "description": "the project id of the private gateway", - "name": "projectid", - "type": "string" - }, - { - "description": "the network implementation uri for the private gateway", - "name": "vlan", + "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": "ACL Id set for private gateway", + "name": "aclid", "type": "string" }, { - "description": "the private gateway's ip address", - "name": "ipaddress", + "description": "zone id of the private gateway", + "name": "zoneid", "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", "name": "account", "type": "string" }, { - "description": "the ID of the domain associated with the private gateway", - "name": "domainid", - "type": "string" - }, - { - "description": "ACL Id set for private gateway", - "name": "aclid", - "type": "string" - }, - { - "description": "the name of the zone the private gateway belongs to", - "name": "zonename", + "description": "State of the gateway, can be Creating, Ready, Deleting", + "name": "state", "type": "string" }, { @@ -77054,11 +77448,6 @@ "name": "sourcenatsupported", "type": "boolean" }, - { - "description": "ACL name set for private gateway", - "name": "aclname", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -77075,33 +77464,28 @@ "type": "string" }, { - "description": "the domain associated with the private gateway", - "name": "domain", - "type": "string" - }, - { - "description": "the private gateway's netmask", - "name": "netmask", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "VPC id the private gateway belongs to", + "name": "vpcid", "type": "string" }, { - "description": "zone id of the private gateway", - "name": "zoneid", + "description": "the private gateway's ip address", + "name": "ipaddress", "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 ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "ACL name set for private gateway", + "name": "aclname", "type": "string" }, { @@ -77109,25 +77493,55 @@ "name": "hasannotations", "type": "boolean" }, + { + "description": "the private gateway's netmask", + "name": "netmask", + "type": "string" + }, + { + "description": "the project name of the private gateway", + "name": "project", + "type": "string" + }, { "description": "VPC name the private gateway belongs to", "name": "vpcname", "type": "string" }, + { + "description": "the name of the zone the private gateway belongs to", + "name": "zonename", + "type": "string" + }, { "description": "the name of the Network associated with this private gateway", "name": "associatednetwork", "type": "string" }, + {}, { - "description": "the project name of the private gateway", - "name": "project", + "description": "the project id of the private gateway", + "name": "projectid", "type": "string" }, - {}, { - "description": "VPC id the private gateway belongs to", - "name": "vpcid", + "description": "the domain associated with the private gateway", + "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 Network associated with this private gateway", + "name": "associatednetworkid", + "type": "string" + }, + { + "description": "the network implementation uri for the private gateway", + "name": "vlan", "type": "string" } ], @@ -77142,33 +77556,33 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "uuid" } ], "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": "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" } ] }, @@ -77178,24 +77592,17 @@ "name": "uploadSslCert", "params": [ { - "description": "SSL certificate", - "length": 16384, - "name": "certificate", - "required": true, - "type": "string" - }, - { - "description": "Password for the private key", + "description": "Name for the uploaded certificate", "length": 255, - "name": "password", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "account that will own the SSL certificate", - "length": 255, - "name": "account", - "required": false, + "description": "SSL certificate", + "length": 16384, + "name": "certificate", + "required": true, "type": "string" }, { @@ -77213,21 +77620,6 @@ "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", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", - "required": false, - "type": "uuid" - }, { "description": "Enables revocation checking for certificates", "length": 255, @@ -77242,13 +77634,41 @@ "name": "privatekey", "required": true, "type": "string" + }, + { + "description": "account that will own the SSL certificate", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "Password for the private key", + "length": 255, + "name": "password", + "required": false, + "type": "string" + }, + { + "description": "domain ID of the account owning the SSL certificate", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "certificate fingerprint", - "name": "fingerprint", + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + {}, + { + "description": "the project name of the certificate", + "name": "project", "type": "string" }, { @@ -77257,8 +77677,8 @@ "type": "integer" }, { - "description": "the project name of the certificate", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -77266,43 +77686,27 @@ "name": "certificate", "type": "string" }, - { - "description": "the project id of the certificate", - "name": "projectid", - "type": "string" - }, + {}, { "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" }, { - "description": "account for the certificate", - "name": "account", - "type": "string" - }, - { - "description": "SSL certificate ID", - "name": "id", + "description": "certificate fingerprint", + "name": "fingerprint", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the certificate", + "name": "projectid", "type": "string" }, - {}, { "description": "certificate chain", "name": "certchain", @@ -77312,6 +77716,16 @@ "description": "List of loabalancers this certificate is bound to", "name": "loadbalancerrulelist", "type": "list" + }, + { + "description": "account for the certificate", + "name": "account", + "type": "string" + }, + { + "description": "SSL certificate ID", + "name": "id", + "type": "string" } ] }, @@ -77321,26 +77735,25 @@ "name": "updateOauthProvider", "params": [ { - "description": "id of the OAuth provider to be updated", + "description": "Secret Key pre-registered in the specific OAuth provider", "length": 255, - "name": "id", - "related": "updateOauthProvider", - "required": true, - "type": "uuid" + "name": "secretkey", + "required": false, + "type": "string" }, { - "description": "OAuth provider will be enabled or disabled based on this value", + "description": "Redirect URI pre-registered in the specific OAuth provider", "length": 255, - "name": "enabled", + "name": "redirecturi", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Secret Key pre-registered in the specific OAuth provider", + "description": "OAuth provider will be enabled or disabled based on this value", "length": 255, - "name": "secretkey", + "name": "enabled", "required": false, - "type": "string" + "type": "boolean" }, { "description": "Description of the OAuth Provider", @@ -77357,29 +77770,29 @@ "type": "string" }, { - "description": "Redirect URI pre-registered in the specific OAuth provider", + "description": "id of the OAuth provider to be updated", "length": 255, - "name": "redirecturi", - "required": false, - "type": "string" + "name": "id", + "related": "updateOauthProvider", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Secret key registered in the OAuth provider", - "name": "secretkey", + "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": "Description of the provider registered", - "name": "description", + "description": "ID of the provider", + "name": "id", "type": "string" }, { @@ -77388,34 +77801,35 @@ "type": "string" }, { - "description": "ID of the provider", - "name": "id", + "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", + "description": "Redirect URI registered in the OAuth provider", + "name": "redirecturi", "type": "string" }, + {}, { - "description": "Name of the provider", - "name": "provider", - "type": "string" + "description": "Whether the OAuth provider is enabled or not", + "name": "enabled", + "type": "boolean" }, { - "description": "Name of the provider", - "name": "name", + "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", + "description": "Name of the provider", + "name": "provider", "type": "string" }, { - "description": "Whether the OAuth provider is enabled or not", - "name": "enabled", - "type": "boolean" + "description": "Description of the provider registered", + "name": "description", + "type": "string" }, {} ], @@ -77427,34 +77841,32 @@ "name": "createVpnCustomerGateway", "params": [ { - "description": "Lifetime of phase 2 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": "esplifetime", + "name": "account", "required": false, - "type": "long" + "type": "string" }, { - "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", + "description": "name of this customer gateway", "length": 255, - "name": "cidrlist", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Force Encapsulation for NAT traversal", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "forceencap", + "name": "dpd", "required": false, "type": "boolean" }, { - "description": "create site-to-site VPN customer gateway for the project", + "description": "guest cidr list of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "since": "4.6", - "type": "uuid" + "name": "cidrlist", + "required": true, + "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", @@ -77464,6 +77876,13 @@ "since": "4.15.1", "type": "string" }, + { + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "length": 255, + "name": "ikelifetime", + "required": false, + "type": "long" + }, { "description": "IPsec Preshared-Key of the customer gateway. Cannot contain newline or double quotes.", "length": 255, @@ -77472,19 +77891,20 @@ "type": "string" }, { - "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "description": "create site-to-site VPN customer gateway for the project", "length": 255, - "name": "splitconnections", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.15.1", - "type": "boolean" + "since": "4.6", + "type": "uuid" }, { - "description": "name of this customer gateway", + "description": "Force Encapsulation for NAT traversal", "length": 255, - "name": "name", + "name": "forceencap", "required": false, - "type": "string" + "type": "boolean" }, { "description": "ESP policy of the customer gateway", @@ -77494,16 +77914,9 @@ "type": "string" }, { - "description": "IKE policy of the customer gateway", - "length": 255, - "name": "ikepolicy", - "required": true, - "type": "string" - }, - { - "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", + "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikelifetime", + "name": "esplifetime", "required": false, "type": "long" }, @@ -77515,18 +77928,19 @@ "type": "string" }, { - "description": "If DPD is enabled for VPN connection", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "dpd", - "required": false, - "type": "boolean" + "name": "ikepolicy", + "required": true, + "type": "string" }, { - "description": "the account associated with the gateway. Must be used with the domainId parameter.", + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, - "name": "account", + "name": "splitconnections", "required": false, - "type": "string" + "since": "4.15.1", + "type": "boolean" }, { "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.", @@ -77540,41 +77954,21 @@ "related": "updateVpnCustomerGateway", "response": [ { - "description": "the domain path of the owner", - "name": "domainpath", - "type": "string" - }, - { - "description": "IPsec policy of customer gateway", - "name": "esppolicy", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "if DPD is enabled for customer gateway", + "name": "dpd", "type": "boolean" }, { - "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": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "IPsec preshared-key of customer gateway", - "name": "ipsecpsk", + "description": "the domain name of the owner", + "name": "domain", "type": "string" }, + {}, { "description": "name of the customer gateway", "name": "name", @@ -77586,13 +77980,13 @@ "type": "long" }, { - "description": "the owner", - "name": "account", + "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 project id", + "name": "projectid", "type": "string" }, { @@ -77601,8 +77995,13 @@ "type": "date" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the owner", + "name": "account", + "type": "string" + }, + { + "description": "the project name", + "name": "project", "type": "string" }, { @@ -77611,20 +78010,20 @@ "type": "long" }, { - "description": "the project name", - "name": "project", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, - { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" - }, { "description": "IKE policy of customer gateway", "name": "ikepolicy", "type": "string" }, + { + "description": "the domain id of the owner", + "name": "domainid", + "type": "string" + }, { "description": "public ip address id of the customer gateway", "name": "gateway", @@ -77635,31 +78034,46 @@ "name": "ikeversion", "type": "string" }, + {}, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "guest ip of the customer gateway", + "name": "ipaddress", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "if Force NAT Encapsulation is enabled for customer gateway", + "name": "forceencap", + "type": "boolean" + }, + { + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, - {}, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "description": "IPsec preshared-key of customer gateway", + "name": "ipsecpsk", "type": "string" }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "name": "splitconnections", "type": "boolean" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the vpn gateway ID", + "name": "id", + "type": "string" } ] }, @@ -77669,42 +78083,39 @@ "name": "addBaremetalHost", "params": [ { - "description": "the Zone ID for the host", + "description": "the password for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "password", + "required": false, + "type": "string" }, { - "description": "Allocation state of this Host for allocation of new resources", + "description": "the cluster name for the host", "length": 255, - "name": "allocationstate", + "name": "clustername", "required": false, "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "list of tags to be added to the host", "length": 255, - "name": "externaldetails", + "name": "hosttags", "required": false, - "since": "4.21.0", - "type": "map" + "type": "list" }, { - "description": "ip address intentionally allocated to this host after provisioning", + "description": "the host URL", "length": 255, - "name": "ipaddress", - "required": false, + "name": "url", + "required": true, "type": "string" }, { - "description": "the Pod ID for the host", + "description": "ip address intentionally allocated to this host after provisioning", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "ipaddress", + "required": false, + "type": "string" }, { "description": "comma separated list of storage access groups for the host", @@ -77715,18 +78126,12 @@ "type": "list" }, { - "description": "the host URL", - "length": 255, - "name": "url", - "required": true, - "type": "string" - }, - { - "description": "the cluster name for the host", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "clustername", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { "description": "the cluster ID for the host", @@ -77736,6 +78141,14 @@ "required": false, "type": "uuid" }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" + }, { "description": "hypervisor type of the host", "length": 255, @@ -77744,23 +78157,24 @@ "type": "string" }, { - "description": "list of tags to be added to the host", + "description": "the Zone ID for the host", "length": 255, - "name": "hosttags", - "required": false, - "type": "list" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the username for the host; required to be passed for hypervisors other than VMWare", + "description": "Allocation state of this Host for allocation of new resources", "length": 255, - "name": "username", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the password for the host; required to be passed for hypervisors other than VMWare", + "description": "the username for the host; required to be passed for hypervisors other than VMWare", "length": 255, - "name": "password", + "name": "username", "required": false, "type": "string" } @@ -77768,115 +78182,105 @@ "related": "declareHostAsDegraded,listHosts,reconnectHost", "response": [ { - "description": "the state of the host", - "name": "state", - "type": "status" - }, - { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "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 cluster ID of the host", + "name": "clusterid", + "type": "string" }, + {}, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the name of the host", + "name": "name", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", - "type": "long" + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" }, { - "description": "the host version", - "name": "version", - "type": "string" + "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": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", + "description": "Used GPUs on the Host", + "name": "gpuused", "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "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 HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" }, - {}, { "description": "the amount of the host's CPU currently used", "name": "cpuused", "type": "string" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" - }, - { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "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": "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 amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", - "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 cluster name of the host", - "name": "clustername", - "type": "string" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the OS category ID of the host", @@ -77884,54 +78288,54 @@ "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "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": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "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 resource state of the host", - "name": "resourcestate", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "comma-separated list of explicit host tags for the host", + "name": "explicithosttags", "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": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "the ID of the host", - "name": "id", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" }, { "description": "the date and time the host was last pinged", @@ -77939,109 +78343,126 @@ "type": "date" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "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": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the host", - "name": "name", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, + {}, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the management server ID of the host", - "name": "managementserverid", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "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": "true if the host has capability to support UEFI boot", - "name": "ueficapability", - "type": "boolean" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -78061,14 +78482,19 @@ "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", "type": "long" }, { - "description": "Maximum Y resolution per display", - "name": "maxresolutiony", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -78077,8 +78503,8 @@ "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { @@ -78087,19 +78513,14 @@ "type": "long" }, { - "description": "Maximum no. of vgpu per gpu card (pgpu)", - "name": "maxvgpuperpgpu", + "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" } ], "type": "list" @@ -78108,9 +78529,9 @@ "type": "list" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the resource state of the host", + "name": "resourcestate", + "type": "string" }, { "description": "The ID of extension for this cluster", @@ -78118,40 +78539,39 @@ "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "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": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", "type": "long" }, - {}, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, { "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", @@ -78159,55 +78579,49 @@ "type": "long" }, { - "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 virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the admin that annotated this host", + "name": "username", + "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" } ] }, @@ -78227,19 +78641,14 @@ "related": "addAnnotation,listAnnotations", "response": [ { - "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", + "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", - "type": "string" + "description": "the creation timestamp for this annotation", + "name": "created", + "type": "date" }, { "description": "The username of the user that entered the annotation", @@ -78247,15 +78656,13 @@ "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", + "type": "string" }, - {}, - {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "description": "the contents of the annotation", + "name": "annotation", "type": "string" }, { @@ -78263,19 +78670,15 @@ "name": "removed", "type": "date" }, + {}, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "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 contents of the annotation", - "name": "annotation", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, { @@ -78283,11 +78686,22 @@ "name": "id", "type": "string" }, + { + "description": "True if the annotation is available for admins only", + "name": "adminsonly", + "type": "boolean" + }, + { + "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", "type": "string" - } + }, + {} ], "since": "4.11" }, @@ -78306,10 +78720,11 @@ } ], "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" }, { @@ -78322,10 +78737,9 @@ "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" } ], @@ -78348,8 +78762,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" }, {}, @@ -78359,8 +78773,8 @@ "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" }, { @@ -78372,125 +78786,199 @@ "since": "4.9.0" }, { - "description": "Creates and automatically starts a VM from a backup.", - "isasync": true, - "name": "createVMFromBackup", + "description": "Update VM Schedule.", + "isasync": false, + "name": "updateVMSchedule", "params": [ { - "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": "Enable VM schedule", "length": 255, - "name": "iothreadsenabled", + "name": "enabled", "required": false, "type": "boolean" }, { - "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", + "description": "start date from which the schedule becomes activeUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "datadisksdetails", + "name": "startdate", "required": false, - "since": "4.21.0", - "type": "map" + "type": "date" }, { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "Specifies a timezone for this command. For more information on the timezone parameter, see TimeZone Format.", "length": 255, - "name": "affinitygroupids", - "related": "createAffinityGroup,listAffinityGroups", + "name": "timezone", "required": false, - "type": "list" + "type": "string" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "schedule", "required": false, - "since": "4.15.0.0", - "type": "boolean" + "type": "string" }, { - "description": "an optional user generated name for the virtual machine", + "description": "ID of VM schedule", "length": 255, - "name": "displayname", + "name": "id", + "related": "updateVMSchedule", + "required": true, + "type": "uuid" + }, + { + "description": "Name of the schedule", + "length": 255, + "name": "description", "required": false, "type": "string" }, { - "description": "host name for the virtual machine", + "description": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "name", + "name": "enddate", "required": false, + "type": "date" + } + ], + "related": "", + "response": [ + { + "description": "VM schedule is enabled", + "name": "enabled", + "type": "boolean" + }, + { + "description": "Date after which the schedule becomes inactive", + "name": "enddate", + "type": "date" + }, + { + "description": "ID of virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "Deploy vm for the project", + "description": "Action", + "name": "action", + "type": "action" + }, + {}, + { + "description": "Timezone of the schedule", + "name": "timezone", + "type": "string" + }, + { + "description": "Date from which the schedule is active", + "name": "startdate", + "type": "date" + }, + { + "description": "Description of VM schedule", + "name": "description", + "type": "string" + }, + { + "description": "Cron formatted VM schedule", + "name": "schedule", + "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of VM schedule", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Date when the schedule was created", + "name": "created", + "type": "date" + } + ], + "since": "4.19.0" + }, + { + "description": "Creates and automatically starts a VM from a backup.", + "isasync": true, + "name": "createVMFromBackup", + "params": [ + { + "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": "projectid", - "related": "createProject", + "name": "rootdisksize", "required": false, - "type": "uuid" + "since": "4.4", + "type": "long" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "used to specify the vApp properties.", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "properties", "required": false, - "type": "uuid" + "since": "4.15", + "type": "map" }, { - "description": "the ip address for default vm's network", - "length": 255, - "name": "ipaddress", + "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" }, { - "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": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", + "name": "startvm", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "an optional URL encoded string that can be passed to the virtual machine upon successful deployment", - "length": 5120, - "name": "extraconfig", + "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.12", "type": "string" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "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": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "datadiskofferinglist", "required": false, - "since": "4.21", - "type": "uuid" + "since": "4.11", + "type": "map" }, { - "description": "the ID of the template for the virtual machine", + "description": "an optional group 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", + "name": "group", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "Number of days instance is leased for.", "length": 255, - "name": "size", + "name": "leaseduration", "required": false, - "type": "long" + "since": "4.21.0", + "type": "integer" }, { - "description": "The number of queues for multiqueue NICs.", + "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": "nicmultiqueuenumber", + "name": "iptonetworklist", "required": false, - "since": "4.18", - "type": "integer" + "type": "map" }, { "description": "backup ID to create the VM from", @@ -78501,81 +78989,87 @@ "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "externaldetails", + "name": "details", "required": false, - "since": "4.21.0", + "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": "the ID of the Userdata", "length": 255, - "name": "datadiskofferinglist", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "since": "4.11", - "type": "map" + "since": "4.18", + "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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": "displayvm", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", "required": false, - "since": "4.2", - "type": "boolean" + "type": "uuid" }, { - "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": "destination Cluster ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "bootmode", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.21", + "type": "uuid" }, { - "description": "availability zone for the virtual machine", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "copyimagetags", + "required": false, + "since": "4.13", + "type": "boolean" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "affinitygroupnames", - "related": "createAffinityGroup,listAffinityGroups", + "name": "leaseexpiryaction", "required": false, - "type": "list" + "since": "4.21.0", + "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": "Enable packed virtqueues or not.", "length": 255, - "name": "hypervisor", + "name": "nicpackedvirtqueuesenabled", "required": false, - "type": "string" + "since": "4.18", + "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 ID of the service offering for the virtual machine", "length": 255, - "name": "customid", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "used to specify the vApp properties.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "properties", + "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, - "since": "4.15", - "type": "map" + "type": "uuid" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "account", + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", "required": false, - "type": "string" + "since": "4.21", + "type": "uuid" }, { "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.", @@ -78586,111 +79080,79 @@ "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "userdatadetails", + "name": "displayvm", "required": false, - "since": "4.18", - "type": "map" + "since": "4.2", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable", + "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": "dynamicscalingenabled", + "name": "affinitygroupnames", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.16", - "type": "boolean" + "type": "list" }, { - "description": "an optional group for the virtual machine", + "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": "group", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, - "type": "string" + "type": "list" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "affinitygroupids", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "type": "uuid" + "type": "list" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "the ip address for default vm's network", "length": 255, - "name": "deploymentplanner", + "name": "ipaddress", "required": false, - "since": "4.4", "type": "string" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "startvm", + "name": "dynamicscalingenabled", "required": false, + "since": "4.16", "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": "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": "the ID of the Userdata", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "size", "required": false, - "since": "4.18", - "type": "uuid" + "type": "long" }, { - "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": "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": "dhcpoptionsnetworklist", + "name": "nicnetworklist", "required": false, + "since": "4.15", "type": "map" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", - "length": 255, - "name": "leaseexpiryaction", - "required": false, - "since": "4.21.0", - "type": "string" - }, - { - "description": "Number of days instance is leased for.", - "length": 255, - "name": "leaseduration", - "required": false, - "since": "4.21.0", - "type": "integer" - }, - { - "description": "the ipv6 address for default vm's network", + "description": "Controls specific policies on IO", "length": 255, - "name": "ip6address", + "name": "iodriverpolicy", "required": false, "type": "string" }, { - "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" }, { @@ -78702,1662 +79164,136 @@ "type": "list" }, { - "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": "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": "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": "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": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "rootdisksize", + "name": "deploymentplanner", "required": false, "since": "4.4", - "type": "long" - }, - { - "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": "name of the ssh key pair used to login to the virtual machine", - "length": 255, - "name": "keypair", - "required": false, "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": "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": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", + "name": "networkids", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "list" }, { - "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 mac address for default vm's network", - "length": 255, - "name": "macaddress", - "required": false, - "type": "string" - }, - { - "description": "Controls specific policies on IO", - "length": 255, - "name": "iodriverpolicy", - "required": false, - "type": "string" - }, - { - "description": "Enable packed virtqueues or not.", - "length": 255, - "name": "nicpackedvirtqueuesenabled", - "required": false, - "since": "4.18", - "type": "boolean" - }, - { - "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": "keyboard", - "required": false, - "type": "string" - }, - { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "an optional user generated name for the virtual machine", "length": 255, - "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": "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "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": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", - "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": "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 name of the affinity group", - "name": "domain", - "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 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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" - }, - { - "description": "the account owning the affinity group", - "name": "account", - "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" - } - ], - "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": "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": "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": "customer associated with the tag", - "name": "customer", - "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" - } - ], - "type": "set" - }, - { - "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": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "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": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "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": "the name of the host for the virtual machine", - "name": "hostname", - "type": "string" - }, - { - "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": "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", - "type": "string" - }, - { - "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": "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "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 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", + "required": false, "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", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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 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": "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": "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": "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 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": "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" - } - ], - "type": "set" - }, - { - "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": "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": "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" - }, - { - "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" - } - ], - "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" - }, - { - "description": "the project name of the group", - "name": "project", - "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 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 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 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 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 traffic type of the nic", - "name": "traffictype", - "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 IPv6 address of network", - "name": "ip6address", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "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": "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": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "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": "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": "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": "the type of the nic", - "name": "type", - "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": "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": "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 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" - } - ], - "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": "end date after which the schedule becomes inactiveUse format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "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": "ID of VM schedule", - "length": 255, - "name": "id", - "related": "updateVMSchedule", - "required": true, - "type": "uuid" - }, - { - "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": "Enable VM schedule", - "length": 255, - "name": "enabled", - "required": false, - "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'", - "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 VM schedule", - "name": "id", - "type": "string" - }, - { - "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": "Action", - "name": "action", - "type": "action" - }, - { - "description": "Date from which the schedule is active", - "name": "startdate", - "type": "date" - }, - { - "description": "Cron formatted VM schedule", - "name": "schedule", - "type": "string" - }, - { - "description": "Timezone of the schedule", - "name": "timezone", - "type": "string" - }, - { - "description": "Date after which the schedule becomes inactive", - "name": "enddate", - "type": "date" - }, - { - "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.19.0" - }, - { - "description": "Lists all configuration groups (primarily used for UI).", - "isasync": false, - "name": "listConfigurationGroups", - "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "lists configuration group by group name", - "length": 255, - "name": "group", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "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 name of the configuration group", - "name": "name", - "type": "string" - }, - { - "description": "the description of the configuration group", - "name": "description", - "type": "string" - }, - { - "description": "the precedence of the configuration group", - "name": "precedence", - "type": "long" - }, - {}, - {}, - { - "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": "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": "UUID of the Pod IP", - "length": 255, - "name": "id", - "required": true, - "type": "long" - } - ], - "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": "Updates remote access vpn", - "isasync": true, - "name": "updateRemoteAccessVpn", - "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", - "type": "string" - }, - { - "description": "id of the remote access vpn", - "length": 255, - "name": "id", - "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", - "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" - } - ], - "related": "createRemoteAccessVpn,listRemoteAccessVpns", - "response": [ - { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", - "type": "string" - }, - { - "description": "the id of the remote access vpn", - "name": "id", - "type": "string" - }, - { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "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": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "availability zone for the virtual machine", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the account of the remote access vpn", - "name": "account", - "type": "string" + "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": "iothreadsenabled", + "required": false, + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 domain name of the account of the remote access vpn", - "name": "domain", + "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, "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", - "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 public ip address of the vpn server", - "name": "publicipid", + "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": "keyboard", + "required": false, "type": "string" }, { - "description": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The number of queues for multiqueue NICs.", + "length": 255, + "name": "nicmultiqueuenumber", + "required": false, + "since": "4.18", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the mac address for default vm's network", + "length": 255, + "name": "macaddress", + "required": false, "type": "string" }, - {}, - {}, { - "description": "the range of ips to allocate to the clients", - "name": "iprange", + "description": "the ipv6 address for default vm's network", + "length": 255, + "name": "ip6address", + "required": false, "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", - "type": "string" + "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": "the ipsec preshared key", - "name": "presharedkey", + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, "type": "string" }, { - "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": "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": "the virtual machine ID to which the GPU device is allocated", + "description": "Deploy vm for the project", "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", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the host ID where the GPU device is attached", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, "name": "hostid", "related": "declareHostAsDegraded,listHosts,reconnectHost", @@ -80365,88 +79301,149 @@ "type": "uuid" }, { - "description": "", + "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "page", + "name": "password", "required": false, - "type": "integer" + "since": "4.19.0.0", + "type": "string" }, { - "description": "the vGPU profile ID assigned to the GPU device", + "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": "vgpuprofileid", - "related": "createVgpuProfile,updateVgpuProfile", + "name": "datadisksdetails", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "map" }, { - "description": "", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "pagesize", + "name": "bootintosetup", "required": false, - "type": "integer" + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the GPU card ID associated with the GPU device", + "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 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": "gpucardid", - "related": "listGpuCards", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "host name for the virtual machine", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "ID of the GPU device", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "id", - "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "name": "account", "required": false, - "type": "uuid" + "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" } ], - "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "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,createVMFromBackup,importVm", "response": [ { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "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": "publicip", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -80454,199 +79451,146 @@ "type": "integer" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the managed state of the GPU device (Enabled/Disabled)", - "name": "managedstate", - "type": "managedstate" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "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": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "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", "type": "string" }, { - "description": "the ID of the GPU device", - "name": "id", - "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 GPU card ID associated with this GPU device", - "name": "gpucardid", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" + }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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 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": "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": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "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 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 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 maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "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", + "type": "long" }, { "description": "the state of the virtual machine", @@ -80654,23 +79598,28 @@ "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": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { @@ -80678,28 +79627,13 @@ "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", + "description": "the name of the security group", + "name": "name", "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 starting IP of the security group rule", @@ -80707,8 +79641,8 @@ "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" }, { @@ -80717,141 +79651,42 @@ "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", + "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": "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": "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": "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": "the project id the tag belongs to", - "name": "projectid", - "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 CIDR notation for the base IP address of the security group rule", - "name": "cidr", - "type": "string" - } - ], - "type": "set" - }, - { - "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": "security group name", + "name": "securitygroupname", "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 list of resource tags associated with the rule", "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": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -80864,6 +79699,11 @@ "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", @@ -80874,94 +79714,49 @@ "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 key name", - "name": "key", + "description": "tag value", + "name": "value", "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" + "description": "the ending IP of the security group rule ", + "name": "endport", + "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 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 project name of the group", - "name": "project", - "type": "string" - }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -80970,13 +79765,13 @@ "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -80985,376 +79780,357 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 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 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": "path of the Domain associated with the tag", + "name": "domainpath", "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" - } - ], - "type": "set" - }, - { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "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", - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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": "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "description": "the description of the affinity group", - "name": "description", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the project id of the group", + "name": "projectid", + "type": "string" }, { - "description": "the name of the affinity 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 affinity group belongs to", - "name": "domainpath", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project name of the affinity group", + "description": "the project name of the group", "name": "project", "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 security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "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": "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 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": "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 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": "customer associated with the tag", + "name": "customer", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "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", + "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": "the id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "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": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "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", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "the project id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "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 group ID of the virtual machine", + "name": "groupid", + "type": "string" }, - {}, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "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": "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 type of the nic", + "name": "type", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "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", + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -81363,497 +80139,929 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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", + "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 vpc to which the nic belongs", + "name": "vpcid", + "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", + "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": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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 name of the corresponding network", - "name": "networkname", + "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", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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 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": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, - {}, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", - "type": "boolean" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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 memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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 ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, { "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", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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": "User VM type", - "name": "vmtype", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "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 type of the template for the virtual machine", - "name": "templatetype", + "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "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": "the project ID of the affinity group", + "name": "projectid", + "type": "string" + }, + { + "description": "the type of the affinity group", + "name": "type", + "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 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": "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + } + ], + "since": "4.21.0" + }, + { + "description": "Lists all configuration groups (primarily used for UI).", + "isasync": false, + "name": "listConfigurationGroups", + "params": [ + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "", + "length": 255, + "name": "page", + "required": false, "type": "integer" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "lists configuration group by group name", + "length": 255, + "name": "group", + "required": false, "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + {}, + { + "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 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": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the precedence of the configuration group", + "name": "precedence", "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the name of the configuration group", + "name": "name", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the description of the configuration group", + "name": "description", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "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": "Guest vm Boot Mode", - "name": "bootmode", + "description": "UUID of the Pod IP", + "length": 255, + "name": "id", + "required": true, + "type": "long" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "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": "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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 remote access vpn", + "length": 255, + "name": "id", + "related": "createRemoteAccessVpn,listRemoteAccessVpns,updateRemoteAccessVpn", + "required": true, + "type": "uuid" + } + ], + "related": "createRemoteAccessVpn,listRemoteAccessVpns", + "response": [ + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the public ip address of the vpn server", + "name": "publicip", "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 remote access vpn", + "name": "id", "type": "string" }, + {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the range of ips to allocate to the clients", + "name": "iprange", "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "the account of the remote access vpn", + "name": "account", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the public ip address of the vpn server", + "name": "publicipid", + "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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 state of the rule", + "name": "state", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", + "type": "string" + }, + { + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", + "type": "string" } - ] + ], + "since": "4.4" }, { - "description": "Assigns a VM to a backup offering", - "isasync": true, - "name": "assignVirtualMachineToBackupOffering", + "description": "Lists all available GPU devices", + "isasync": false, + "name": "listGpuDevices", "params": [ { - "description": "ID of the backup offering", + "description": "the virtual machine ID to which the GPU device is allocated", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", - "required": true, + "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,createVMFromBackup,importVm", + "required": false, "type": "uuid" }, { - "description": "ID of the virtual machine", + "description": "the GPU card ID associated with the GPU device", "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, + "name": "gpucardid", + "related": "listGpuCards", + "required": false, + "type": "uuid" + }, + { + "description": "the vGPU profile ID assigned to the GPU device", + "length": 255, + "name": "vgpuprofileid", + "related": "createVgpuProfile,updateVgpuProfile", + "required": false, + "type": "uuid" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the host ID where the GPU device is attached", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "ID of the GPU device", + "length": 255, + "name": "id", + "related": "listGpuDevices,listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", "response": [ + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "vgpuprofilename", + "type": "string" + }, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the host ID where the GPU device is attached", + "name": "hostid", + "type": "string" + }, + { + "description": "the host name where the GPU device is attached", + "name": "hostname", + "type": "string" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the GPU card name associated with this GPU device", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the NUMA node where the GPU device is located", + "name": "numanode", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "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" + }, {}, + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", + "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 vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" + "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", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" } ], - "since": "4.14.0" + "since": "4.21.0" }, { - "description": "Starts a virtual machine.", + "description": "Destroys a virtual machine. Once destroyed, only the administrator can recover it.", "isasync": true, - "name": "startVirtualMachine", + "name": "destroyVirtualMachine", "params": [ { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "Comma separated list of UUIDs for volumes that will be deleted", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "volumeids", + "related": "createVolume,updateVolume,listVolumes,uploadVolume,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "uuid" + "since": "4.12.0", + "type": "list" }, { - "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "description": "If true is passed, the vm is expunged immediately. False by default.", "length": 255, - "name": "podid", - "related": "createPod,listPods,createManagementNetworkIpRange", + "name": "expunge", "required": false, - "type": "uuid" + "since": "4.2.1", + "type": "boolean" }, { "description": "The ID of the virtual machine", "length": 255, "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", + "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,createVMFromBackup,importVm", "required": true, "type": "uuid" + } + ], + "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,createVMFromBackup,importVm", + "response": [ + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "Boot into hardware setup menu or not", - "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "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, - "since": "3.0.1", - "type": "uuid" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", - "length": 255, - "name": "deploymentplanner", - "required": false, - "since": "4.4", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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.", - "length": 255, - "name": "considerlasthost", - "required": false, - "since": "4.18.0", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "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": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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": "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 group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -81862,30 +81070,29 @@ "type": "long" }, { - "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", - "type": "boolean" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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" }, { "description": "the ID of the ISO attached to the virtual machine", @@ -81893,84 +81100,224 @@ "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the name of the affinity group", + "name": "name", + "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": "the project name of the affinity group", + "name": "project", + "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 account owning the affinity group", + "name": "account", + "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 domain ID of the affinity group", + "name": "domainid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "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": "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": "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": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + } + ], + "type": "set" + }, { "description": "the date when this virtual machine was created", "name": "created", "type": "date" }, + {}, { - "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 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", + "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "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": "device type of the root volume", + "name": "rootdevicetype", + "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { "description": "the date when this virtual machine was updated last time", @@ -81978,13 +81325,8 @@ "type": "date" }, { - "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", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { @@ -81993,53 +81335,53 @@ "type": "boolean" }, { - "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": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "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" }, { @@ -82048,53 +81390,58 @@ "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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 gateway of IPv6 network", @@ -82102,14 +81449,14 @@ "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 IPv6 address of network", - "name": "ip6address", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { "description": "the ip address of the nic", @@ -82117,33 +81464,43 @@ "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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", + "description": "the netmask of the nic", + "name": "netmask", "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" }, { - "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": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -82152,24 +81509,34 @@ "type": "integer" }, { - "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "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": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" }, { "description": "the name of the corresponding network", @@ -82177,137 +81544,720 @@ "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the traffic type of the nic", + "name": "traffictype", + "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", + "type": "string" + }, { "description": "name of the vpc to which the nic belongs", "name": "vpcname", "type": "string" }, { - "description": "the ID of the nic", + "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" + } + ], + "type": "set" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ + { + "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the security group", + "name": "name", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 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", + "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": "the project name where tag belongs to", + "name": "project", + "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": "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": "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 protocol of the security group rule", + "name": "protocol", + "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 id of the security group rule", + "name": "ruleid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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 egress rules associated with the security group", + "name": "egressrule", + "response": [ + { + "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" + }, + { + "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 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", + "type": "integer" + }, + { + "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": "tag key name", + "name": "key", + "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 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", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "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", + "name": "account", + "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": "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, - {}, + {}, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "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": "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "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 user's name who deployed the virtual machine", + "name": "username", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "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", + "type": "long" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + } + ] + }, + { + "description": "Assigns a VM to a backup offering", + "isasync": true, + "name": "assignVirtualMachineToBackupOffering", + "params": [ + { + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "ID of the backup offering", + "length": 255, + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", + "required": true, + "type": "uuid" + } + ], + "response": [ + { + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, + {}, + {}, { - "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 VM's primary IP address", - "name": "ipaddress", - "type": "string" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" + } + ], + "since": "4.14.0" + }, + { + "description": "Starts a virtual machine.", + "isasync": true, + "name": "startVirtualMachine", + "params": [ + { + "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": "considerlasthost", + "required": false, + "since": "4.18.0", + "type": "boolean" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "Boot into hardware setup menu or not", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", + "type": "boolean" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "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, + "since": "3.0.1", + "type": "uuid" }, { - "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": "destination Pod ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "podid", + "related": "createPod,listPods,createManagementNetworkIpRange", + "required": false, + "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" + } + ], + "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,createVMFromBackup,importVm", + "response": [ + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "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": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { @@ -82316,72 +82266,57 @@ "type": "long" }, { - "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": "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "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": "ssh key-pairs", - "name": "keypairs", - "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 domain name of the affinity group", - "name": "domain", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -82390,18 +82325,13 @@ "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "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 ID of the affinity group", - "name": "id", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -82415,8 +82345,23 @@ "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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 domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { @@ -82425,36 +82370,164 @@ "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the description of the affinity group", + "name": "description", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + {}, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the project id of the vm", + "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": "the domain ID of the affinity group", + "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": "the ID of the domain associated with the tag", "name": "domainid", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "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 description of the security group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the group", + "name": "project", + "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 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 resource tags associated with the rule", @@ -82466,13 +82539,8 @@ "type": "string" }, { - "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" }, { @@ -82481,13 +82549,13 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -82496,99 +82564,64 @@ "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": "resource type", + "name": "resourcetype", "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": "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 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 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 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" }, - { - "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 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 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", + "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" }, { @@ -82597,82 +82630,147 @@ "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" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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": "customer associated with the tag", "name": "customer", "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" } ], "type": "set" }, + { + "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": "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": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "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": "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 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 type of the ICMP message response", - "name": "icmptype", + "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" + }, + { + "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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -82681,23 +82779,23 @@ "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 account associated with the tag", - "name": "account", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -82706,266 +82804,582 @@ "type": "string" }, { - "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": "the project id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "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" } ], "type": "set" }, { - "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": "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 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", + "description": "the type of the ICMP message response", + "name": "icmptype", "type": "integer" } ], "type": "set" }, { - "description": "the project name of the group", - "name": "project", + "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": "the domain name of the security group", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "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 memory used by the VM in KiB", + "name": "memorykbs", + "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", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the account owning the security group", - "name": "account", + "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": "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 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 isolation uri of the nic", + "name": "isolationuri", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the type of the nic", + "name": "type", + "type": "string" + }, + { + "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": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "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": "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "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": "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", + "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "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": "publicip", + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "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": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "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 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 user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + {}, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", "type": "integer" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "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": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "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": "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": "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" - }, - { - "description": "tag value", - "name": "value", - "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" - } - ], - "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", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "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 type of the template for the virtual machine", - "name": "templatetype", + "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", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Base64 string containing the user data", + "name": "userdata", "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 id of userdata used for the VM", - "name": "userdataid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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 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", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" } ] }, @@ -82975,33 +83389,28 @@ "name": "listResourceIcon", "params": [ { - "description": "type of the resource", + "description": "list of resources to upload the icon/image for", "length": 255, - "name": "resourcetype", + "name": "resourceids", "required": true, - "type": "string" + "type": "list" }, { - "description": "list of resources to upload the icon/image for", + "description": "type of the resource", "length": 255, - "name": "resourceids", + "name": "resourcetype", "required": true, - "type": "list" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, - { - "description": "resource type", - "name": "resourcetype", - "type": "resourceobjecttype" - }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -83012,12 +83421,17 @@ "name": "base64image", "type": "string" }, + {}, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "resource type", + "name": "resourcetype", + "type": "resourceobjecttype" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ], "since": "4.16.0.0" }, @@ -83027,30 +83441,9 @@ "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", + "description": "the ending IP address for the Pod", "length": 255, - "name": "netmask", + "name": "endip", "required": false, "type": "string" }, @@ -83078,141 +83471,83 @@ "type": "list" }, { - "description": "the ending IP address for the Pod", + "description": "the netmask for the Pod", "length": 255, - "name": "endip", + "name": "netmask", "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", + "description": "Allocation state of this Pod for allocation of new resources", + "length": 255, "name": "allocationstate", + "required": false, "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", + "description": "the gateway for the Pod", + "length": 255, + "name": "gateway", + "required": false, "type": "string" }, { "description": "the name of the Pod", + "length": 255, "name": "name", + "required": true, "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" - }, + } + ], + "related": "listPods,createManagementNetworkIpRange", + "response": [ { - "description": "the IP ranges for the Pod", - "name": "ipranges", + "description": "the capacity of the Pod", + "name": "capacity", "response": [ { - "description": "the starting IP for the range", - "name": "startip", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the ending IP for the range", - "name": "endip", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the gateway for the range", - "name": "gateway", + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "indicates Vlan ID for the range", - "name": "vlanid", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "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": "the total capacity available", + "name": "capacitytotal", + "type": "long" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity name", - "name": "name", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -83221,63 +83556,142 @@ "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the Zone ID of the Pod", + "name": "zoneid", + "type": "string" + }, + { + "description": "the allocation state of the Pod", + "name": "allocationstate", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "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": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the ending IP for the range", + "name": "endip", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the starting IP for the range", + "name": "startip", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "indicates Vlan ID for the range", + "name": "vlanid", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the CIDR for the range", + "name": "cidr", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the gateway for the range", + "name": "gateway", + "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "the netmask of the Pod", + "name": "netmask", + "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 ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the gateway of the Pod", + "name": "gateway", + "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 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 ID of the Pod", + "name": "id", + "type": "string" + }, + {} ] }, { @@ -83294,28 +83708,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": "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.6.0" }, @@ -83324,6 +83738,14 @@ "isasync": true, "name": "provisionCertificate", "params": [ + { + "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" + }, { "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, @@ -83337,32 +83759,24 @@ "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", + "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" }, { @@ -83379,132 +83793,128 @@ "name": "listVirtualMachinesMetrics", "params": [ { - "description": "the instances by userdata", + "description": "list by the service offering", "length": 255, - "name": "userdataid", - "related": "listCniConfiguration", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.20.1", + "since": "4.4", "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "description": "the target hypervisor for the template", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains,moveDomain", + "name": "hypervisor", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value, data for all matching VMs will be returned)", + "description": "list vms by template", "length": 255, - "name": "name", + "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": "string" + "type": "uuid" }, { - "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "userdata", + "name": "account", "required": false, - "since": "4.18.0.0", - "type": "boolean" + "type": "string" }, { - "description": "the pod ID", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "required": false, "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "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": "isrecursive", + "name": "gpuenabled", "required": false, + "since": "4.21.0", "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.", + "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": "isvnf", + "name": "accumulate", "required": false, - "since": "4.19.0", + "since": "4.17.0", "type": "boolean" }, { - "description": "the availability zone ID", + "description": "the storage ID where vm's volumes belong to", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "the ID of AutoScaling VM Group", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "autoscalevmgroupid", - "related": "enableAutoScaleVmGroup", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.18.0", "type": "uuid" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "list vms by vpc", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.21.0", "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the virtual machine", "length": 255, - "name": "displayvm", + "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,createVMFromBackup,importVm", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list vms by iso", + "description": "the host ID", "length": 255, - "name": "isoid", + "name": "hostid", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, "type": "uuid" }, { - "description": "the group ID", + "description": "List by keyword", "length": 255, - "name": "groupid", - "related": "updateInstanceGroup", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network id", + "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", "length": 255, - "name": "networkid", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "forvirtualnetwork", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the storage ID where vm's volumes belong to", + "description": "CPU arch of the VM", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "name": "arch", "required": false, - "type": "uuid" + "since": "4.20.1", + "type": "string" }, { - "description": "flag to display the resource icon for VMs", + "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": "showicon", + "name": "details", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "list" }, { "description": "List resources by tags (key/value pairs)", @@ -83514,12 +83924,11 @@ "type": "map" }, { - "description": "the user ID that created the VM and is under the account that owns the VM", + "description": "", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -83529,111 +83938,164 @@ "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.", + "description": "list by network id", "length": 255, - "name": "details", + "name": "networkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "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": "list only resources belonging to the domain specified", "length": 255, - "name": "state", + "name": "domainid", + "related": "createDomain,listDomains,listDomains,moveDomain", + "required": false, + "type": "uuid" + }, + { + "description": "list vms by ssh keypair name", + "length": 255, + "name": "keypair", "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.", + "description": "the security group ID", "length": 255, - "name": "accumulate", + "name": "securitygroupid", + "related": "updateSecurityGroup", + "required": false, + "since": "4.15", + "type": "uuid" + }, + { + "description": "list vms by iso", + "length": 255, + "name": "isoid", + "required": false, + "type": "uuid" + }, + { + "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,createVMFromBackup,importVm", + "required": false, + "since": "4.4", + "type": "list" + }, + { + "description": "makes the API's response contains only the resource count", + "length": 255, + "name": "retrieveonlyresourcecount", "required": false, - "since": "4.17.0", "type": "boolean" }, { - "description": "list vms by affinity group", + "description": "list by the backup offering", "length": 255, - "name": "affinitygroupid", - "related": "createAffinityGroup,listAffinityGroups", + "name": "backupofferingid", + "related": "listBackupOfferings,updateBackupOffering", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "list by network type; true if need to list vms using Virtual Network, false otherwise", + "description": "the availability zone ID", "length": 255, - "name": "forvirtualnetwork", + "name": "zoneid", + "related": "listZones", + "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.", + "length": 255, + "name": "isvnf", "required": false, + "since": "4.19.0", "type": "boolean" }, { - "description": "", + "description": "the group ID", "length": 255, - "name": "pagesize", + "name": "groupid", + "related": "updateInstanceGroup", "required": false, - "type": "integer" + "type": "uuid" }, { - "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.", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "gpuenabled", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,registerExtension,unregisterExtension", "required": false, "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "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", + "name": "displayvm", "required": false, "since": "4.4", - "type": "list" + "type": "boolean" }, { - "description": "list vms by ssh keypair name", + "description": "the pod ID", "length": 255, - "name": "keypair", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "keyword", + "name": "autoscalevmgroupid", + "related": "enableAutoScaleVmGroup", + "required": false, + "since": "4.18.0", + "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.", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "list vms by vpc", + "description": "the instances by userdata", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, + "since": "4.20.1", "type": "uuid" }, { - "description": "list by the service offering", + "description": "the cluster ID", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "CPU arch of the VM", + "description": "list vms by affinity group", "length": 255, - "name": "arch", + "name": "affinitygroupid", + "related": "createAffinityGroup,listAffinityGroups", "required": false, - "since": "4.20.1", - "type": "string" + "type": "uuid" }, { - "description": "list by the High Availability offering; true if filtering VMs with HA enabled; false for VMs with HA disabled", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "haenable", + "name": "isrecursive", "required": false, - "since": "4.15", "type": "boolean" }, { @@ -83644,12 +84106,27 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Whether to return the VMs' user data or not. By default, user data will not be returned.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "userdata", "required": false, - "type": "uuid" + "since": "4.18.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)", + "length": 255, + "name": "name", + "required": false, + "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": "Whether to return only leased instances", @@ -83660,157 +84137,281 @@ "type": "boolean" }, { - "description": "list by the backup offering", + "description": "flag to display the resource icon for VMs", "length": 255, - "name": "backupofferingid", - "related": "listBackupOfferings,updateBackupOffering", + "name": "showicon", "required": false, - "since": "4.17", - "type": "uuid" + "since": "4.16.0.0", + "type": "boolean" + } + ], + "related": "listVirtualMachinesMetrics", + "response": [ + { + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "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": "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 ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the total memory capacity in GiB", + "name": "memorytotal", + "type": "string" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "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": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + {}, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", + "type": "string" }, { - "description": "the target hypervisor for the template", - "length": 255, - "name": "hypervisor", - "required": false, + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the security group ID", - "length": 255, - "name": "securitygroupid", - "related": "updateSecurityGroup", - "required": false, - "since": "4.15", - "type": "uuid" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { - "description": "the cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "makes the API's response contains only the resource count", - "length": 255, - "name": "retrieveonlyresourcecount", - "required": false, + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the host ID", - "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,listHosts,reconnectHost", - "required": false, - "type": "uuid" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" }, { - "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", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "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 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" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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" }, { - "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 isolation uri of the nic", + "name": "isolationuri", "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": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" }, { "description": "the ip address of the nic", @@ -83818,59 +84419,64 @@ "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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 IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "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", + "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": "macaddress", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the gateway of the nic", + "name": "gateway", "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "device id for the network when plugged into the virtual machine", @@ -83878,562 +84484,229 @@ "type": "string" }, { - "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", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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 (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 name of the corresponding network", + "name": "networkname", + "type": "string" } ], "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", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "network read in MiB", - "name": "networkread", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Guest vm Boot Type", + "name": "boottype", + "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 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": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the read (IO) of disk on the VM", + "name": "diskioread", "type": "long" }, { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" + "description": "the total disk iops", + "name": "diskiopstotal", + "type": "long" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotal", + "description": "network write in MiB", + "name": "networkwrite", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the project id of the vm", + "name": "projectid", "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", + "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 account associated with the tag", - "name": "account", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", - "type": "string" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "id of the resource", - "name": "resourceid", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain name of the affinity group", + "name": "domain", "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", + "description": "network read in MiB", + "name": "networkread", "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", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { @@ -84441,94 +84714,27 @@ "name": "securitygroup", "response": [ { - "description": "the account owning the security group", - "name": "account", - "type": "string" - }, - { - "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 name of the security group", - "name": "name", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "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 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": "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", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -84536,83 +84742,83 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "id of the resource", - "name": "resourceid", + "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": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "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 ID of the domain associated with the tag", + "name": "domainid", "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": "resource type", + "name": "resourcetype", "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 type of the ICMP message response", + "name": "icmptype", + "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", @@ -84624,60 +84830,122 @@ "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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" } ], "type": "set" }, { - "description": "the ID of the security group", - "name": "id", + "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 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 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": "tag key name", + "name": "key", + "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": "id of the resource", + "name": "resourceid", + "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" + } + ], "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the project name of the group", + "name": "project", "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 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 code for the ICMP message response", - "name": "icmpcode", - "type": "integer" + "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": "security group name", - "name": "securitygroupname", + "description": "account owning the security group rule", + "name": "account", "type": "string" }, { @@ -84685,8 +84953,13 @@ "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", "type": "string" }, { @@ -84695,13 +84968,13 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -84710,8 +84983,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -84720,209 +84993,350 @@ "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 name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "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" } ], "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", + "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 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", + "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" } ], "type": "set" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "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" } ], "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "disk read in MiB", - "name": "diskread", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "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": "publicip", + "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": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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", + "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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "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 cpu capacity in Ghz", + "name": "cputotal", + "type": "string" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "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 project id of the vm", - "name": "projectid", + "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": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" + }, + { + "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": "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", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "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 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 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 read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "disk write in MiB", + "name": "diskwrite", + "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "the video RAM size in MB", + "name": "videoram", + "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": "disk read in MiB", + "name": "diskread", "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "customer associated with the tag", + "name": "customer", + "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": "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", + "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": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" } ] }, @@ -84939,24 +85353,41 @@ "type": "string" }, { - "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "description": "", "length": 255, - "name": "hypervisor", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "lists hosts existing in particular cluster", + "description": "the id of the management server", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "managementserverid", + "related": "listManagementServers", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "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": "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,createVMFromBackup,importVm", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "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": "outofbandmanagementpowerstate", "required": false, "type": "string" }, @@ -84969,13 +85400,11 @@ "type": "string" }, { - "description": "the id of the management server", + "description": "List by keyword", "length": 255, - "name": "managementserverid", - "related": "listManagementServers", + "name": "keyword", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "string" }, { "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", @@ -84985,33 +85414,27 @@ "type": "list" }, { - "description": "List by keyword", + "description": "list hosts for which out-of-band management is enabled", "length": 255, - "name": "keyword", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "the Pod ID for the host", "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", + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "the id of the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "name": "id", + "related": "declareHostAsDegraded,listHosts,reconnectHost", "required": false, - "type": "string" + "type": "uuid" }, { "description": "if true, list only hosts dedicated to HA", @@ -85021,19 +85444,19 @@ "type": "boolean" }, { - "description": "the host type", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "type", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the id of the host", + "description": "the state of the host", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,listHosts,reconnectHost", + "name": "state", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the Zone ID for the host", @@ -85044,130 +85467,115 @@ "type": "uuid" }, { - "description": "", + "description": "the host type", "length": 255, - "name": "page", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the name of the host", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "name", + "name": "hypervisor", "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", + "description": "the name of the host", "length": 255, - "name": "storageaccessgroup", + "name": "name", "required": false, - "since": "4.21.0", "type": "string" } ], "related": "declareHostAsDegraded,reconnectHost", "response": [ { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "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", - "type": "string" + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", - "type": "string" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the Zone name of the host", + "name": "zonename", "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, - {}, { - "description": "capabilities of the host", - "name": "capabilities", + "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": "comma-separated list of tags for the host", + "name": "hosttags", + "type": "string" }, { - "description": "the CPU speed of the host", - "name": "cpuspeed", + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", "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", + "description": "the amount of the host's CPU currently allocated", + "name": "cpuallocated", "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" }, { "description": "the admin that annotated this host", @@ -85175,74 +85583,105 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "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 after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", - "type": "string" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", - "type": "string" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the date and time the host was removed", + "name": "removed", + "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 Pod name of the host", + "name": "podname", "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "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": "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 local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "the IP address of the host", + "name": "ipaddress", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { "description": "GPU cards present in the host", @@ -85253,18 +85692,13 @@ "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", + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "description": "Video RAM for this vGPU type", + "name": "videoram", "type": "long" }, { @@ -85273,13 +85707,13 @@ "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 vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" }, { @@ -85288,8 +85722,13 @@ "type": "string" }, { - "description": "Video RAM for this vGPU type", - "name": "videoram", + "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" } ], @@ -85304,29 +85743,24 @@ "type": "list" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" - }, - { - "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": "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 total disk size of the host", @@ -85334,94 +85768,94 @@ "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" }, { - "description": "the cluster name of the host", - "name": "clustername", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "CPU Arch of the host", + "name": "arch", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "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 cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "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 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", + "type": "boolean" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "the amount of the host's memory currently used", - "name": "memoryused", - "type": "long" + "description": "the Pod ID of the host", + "name": "podid", + "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": "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": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "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 name of the host", + "name": "name", + "type": "string" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "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 last pinged", - "name": "lastpinged", - "type": "date" + "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", @@ -85429,101 +85863,81 @@ "type": "boolean" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "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 resource state of the host", + "name": "resourcestate", + "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" }, { - "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", - "name": "memorywithoverprovisioning", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, - {}, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the hypervisor version", + "name": "hypervisorversion", + "type": "string" }, + {}, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "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 host version", + "name": "version", + "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": "the name of the host", - "name": "name", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" }, {}, { - "description": "the amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the OS category ID of the host", + "name": "oscategoryid", "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 cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" - }, - { - "description": "the host version", - "name": "version", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" } ] }, @@ -85532,13 +85946,6 @@ "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, @@ -85546,31 +85953,38 @@ "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": "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" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -85588,28 +86002,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": "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 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.17.0.0" }, @@ -85618,6 +86032,13 @@ "isasync": false, "name": "updateStoragePool", "params": [ + { + "description": "comma-separated list of tags for the storage pool", + "length": 255, + "name": "tags", + "required": false, + "type": "list" + }, { "description": "false to disable the pool for allocation of new volumes, true to enable it back.", "length": 255, @@ -85632,21 +86053,6 @@ "required": false, "type": "boolean" }, - { - "description": "IOPS CloudStack can provision from this storage pool", - "length": 255, - "name": "capacityiops", - "required": false, - "type": "long" - }, - { - "description": "the Id of the storage pool", - "length": 255, - "name": "id", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - }, { "description": "bytes CloudStack can provision from this storage pool", "length": 255, @@ -85663,20 +86069,19 @@ "type": "map" }, { - "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": "comma-separated list of tags for the storage pool", + "description": "the Id of the storage pool", "length": 255, - "name": "tags", - "required": false, - "type": "list" + "name": "id", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" }, { "description": "the URL of the storage pool", @@ -85685,15 +86090,54 @@ "required": false, "since": "4.19.0", "type": "string" + }, + { + "description": "Change the name of the storage pool", + "length": 255, + "name": "name", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,updateStoragePool,syncStoragePool,updateStorageCapabilities", + "required": false, + "since": "4.15", + "type": "string" } ], "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "response": [ + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the date and time the storage pool was created", "name": "created", "type": "date" }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, + { + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, { "description": "the overprovisionfactor for the storage pool", "name": "overprovisionfactor", @@ -85704,25 +86148,24 @@ "name": "zoneid", "type": "string" }, - { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" - }, - {}, { "description": "the tags for the storage pool", "name": "tags", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { @@ -85731,89 +86174,75 @@ "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" - }, - { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" - }, - { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" - }, - { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "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 IP address of the storage pool", - "name": "ipaddress", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the name of the storage pool", + "name": "name", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" + }, + { + "description": "the pool's currently used disk size", + "name": "disksizeused", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the IP address of the storage pool", + "name": "ipaddress", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, { "description": "the storage pool type", @@ -85821,50 +86250,40 @@ "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" + }, + {}, + { + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "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 Zone name of the storage pool", "name": "zonename", "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 storage pool details", - "name": "details", - "type": "map" - }, - { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, { "description": "the state of the storage pool", "name": "state", "type": "storagepoolstatus" - }, - {}, - { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" } ], "since": "3.0.0" @@ -85874,13 +86293,6 @@ "isasync": false, "name": "listBackupRepositories", "params": [ - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -85896,12 +86308,11 @@ "type": "string" }, { - "description": "ID of the backup repository", + "description": "", "length": 255, - "name": "id", - "related": "addBackupRepository,listBackupRepositories", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "name of the backup repository", @@ -85910,10 +86321,18 @@ "required": false, "type": "string" }, + { + "description": "ID of the backup repository", + "length": 255, + "name": "id", + "related": "addBackupRepository,listBackupRepositories", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -85929,13 +86348,13 @@ "related": "addBackupRepository", "response": [ { - "description": "the date and time the backup repository was added", - "name": "created", - "type": "date" + "description": "the Zone name of the backup repository", + "name": "zonename", + "type": "string" }, { - "description": "backup type", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -85945,18 +86364,8 @@ }, {}, { - "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", - "name": "zonename", - "type": "string" - }, - { - "description": "the ID of the backup repository", - "name": "id", + "description": "the name of the backup repository", + "name": "name", "type": "string" }, { @@ -85965,26 +86374,41 @@ "type": "long" }, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" }, { - "description": "the name of the backup repository", - "name": "name", + "description": "backup type", + "name": "type", "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": "the address / url of the backup repository", "name": "address", "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": "name of the provider", + "name": "provider", + "type": "string" + } ], "since": "4.20.0" }, @@ -85994,9 +86418,9 @@ "name": "listTungstenFabricTag", "params": [ { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "vmuuid", + "name": "taguuid", "required": false, "type": "string" }, @@ -86008,13 +86432,6 @@ "required": false, "type": "uuid" }, - { - "description": "the uuid of Tungsten-Fabric tag", - "length": 255, - "name": "taguuid", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -86023,16 +86440,9 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric nic", - "length": 255, - "name": "nicuuid", - "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" }, @@ -86044,9 +86454,9 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "policyuuid", + "name": "vmuuid", "required": false, "type": "string" }, @@ -86063,41 +86473,55 @@ "name": "applicationpolicysetuuid", "required": false, "type": "string" + }, + { + "description": "the uuid of Tungsten-Fabric nic", + "length": 255, + "name": "nicuuid", + "required": false, + "type": "string" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "applyTungstenFabricTag", "response": [ + {}, { - "description": "list Tungsten-Fabric policy", - "name": "policy", - "type": "list" + "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 tag name", + "name": "name", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list Tungsten-Fabric nic", + "name": "nic", + "type": "list" }, + {}, { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric vm", + "name": "vm", "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", + "type": "string" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", - "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", @@ -86105,19 +86529,19 @@ "type": "string" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric policy", + "name": "policy", "type": "list" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric network", + "name": "network", + "type": "list" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -86134,61 +86558,61 @@ "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Creates the user under the specified account. If no account is specified, the username will be used as the account name.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "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": "uuid" + "type": "map" }, { - "description": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", + "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": "accounttype", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { - "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": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "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": "Type of the account. Specify 0 for user, 1 for root admin, and 2 for domain admin", "length": 255, - "name": "group", + "name": "accounttype", "required": false, - "type": "string" + "type": "integer" }, { - "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.", @@ -86206,13 +86630,6 @@ "name": "domain", "type": "string" }, - {}, - { - "description": "The user's username", - "name": "username", - "type": "string" - }, - {}, { "description": "The user's email", "name": "email", @@ -86224,10 +86641,21 @@ "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "The user's firstname", + "name": "firstname", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -86239,15 +86667,11 @@ "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "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" - } + {} ], "since": "4.3.0" }, @@ -86276,78 +86700,89 @@ "related": "createDomain,listDomains,listDomains", "response": [ { - "description": "the date when this domain was created", - "name": "created", - "type": "date" + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "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 number of virtual machines that can be deployed by this domain", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the level of the domain", + "name": "level", "type": "integer" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "description": "the total number of virtual machines deployed by this domain", + "name": "vmtotal", "type": "long" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { @@ -86356,211 +86791,205 @@ "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" - }, - { - "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", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", + "description": "the total number of gpus owned by domain", + "name": "gputotal", "type": "long" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", + "type": "long" }, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "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 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 total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "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 primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, - {}, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "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 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 network domain", + "name": "networkdomain", "type": "string" }, { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", + "type": "long" }, - {}, { - "description": "the name of the domain", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the total number of templates which can be created by this domain", - "name": "templatelimit", + "description": "the total volume which can be used by this domain", + "name": "volumelimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", - "type": "string" + "description": "the total number of backups stored by this domain", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" + }, + { + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { "description": "the total memory (in MB) the domain can own", @@ -86568,18 +86997,13 @@ "type": "string" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { @@ -86588,29 +87012,29 @@ "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "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 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 projects the domain can own", - "name": "projectlimit", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" } ], "since": "4.19.0.0" @@ -86621,34 +87045,33 @@ "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.", + "description": "the ID or VID of the network", "length": 255, - "name": "listall", + "name": "vlan", "required": false, - "type": "boolean" + "since": "4.17.0", + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "flag to display the resource icon for networks", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "showicon", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "list networks by network offering ID", + "description": "the type of the network. Supported values are: isolated, l2, shared and all", "length": 255, - "name": "networkofferingid", - "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "name": "type", "required": false, - "type": "uuid" + "type": "string" }, { - "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).", + "description": "list networks by name", "length": 255, - "name": "networkfilter", + "name": "name", "required": false, - "since": "4.17.0", + "since": "4.22.0", "type": "string" }, { @@ -86660,24 +87083,17 @@ "type": "boolean" }, { - "description": "list networks by ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", - "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "true if network is system, false otherwise", - "length": 255, - "name": "issystem", - "required": false, - "type": "boolean" - }, - { - "description": "the network belongs to VPC", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "forvpc", + "name": "retrieveonlyresourcecount", "required": false, "type": "boolean" }, @@ -86697,129 +87113,145 @@ "type": "uuid" }, { - "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": "list resources by account. Must be used with the domainId parameter.", + "description": "list networks by ACL (access control list) type. Supported values are account and domain", "length": 255, - "name": "account", + "name": "acltype", "required": false, "type": "string" }, { - "description": "list networks by ACL (access control list) type. Supported values are account and domain", + "description": "the zone ID of the network", "length": 255, - "name": "acltype", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if need to list only networks which support specifying IP ranges", + "description": "list networks by restartRequired", "length": 255, - "name": "specifyipranges", + "name": "restartrequired", "required": false, "type": "boolean" }, { - "description": "the ID or VID of the network", + "description": "", "length": 255, - "name": "vlan", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "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": "type of the traffic", + "description": "list networks by ID", "length": 255, - "name": "traffictype", + "name": "id", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "list networks by network offering ID", "length": 255, - "name": "tags", + "name": "networkofferingid", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "description": "list networks supporting certain services", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "supportedservices", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "List by keyword", + "description": "true if need to list only networks which support specifying IP ranges", "length": 255, - "name": "keyword", + "name": "specifyipranges", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "true if network is system, false otherwise", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "issystem", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the type of the network. Supported values are: isolated, l2, shared and all", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "flag to display the resource icon for networks", + "description": "the network belongs to VPC", "length": 255, - "name": "showicon", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "list networks by physical network id", + "description": "type of the traffic", "length": 255, - "name": "physicalnetworkid", - "related": "listPhysicalNetworks,updatePhysicalNetwork", + "name": "traffictype", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "list networks available for VM deployment", + "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": "canusefordeploy", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "the zone ID of the network", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "", + "description": "List networks by associated networks. Only available if create a Shared network.", "length": 255, - "name": "pagesize", + "name": "associatednetworkid", + "related": "createNetwork,listNetworks,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, - "type": "integer" + "since": "4.17.0", + "type": "uuid" }, { - "description": "list networks supporting certain services", + "description": "list networks by physical network id", "length": 255, - "name": "supportedservices", + "name": "physicalnetworkid", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "list" + "type": "uuid" }, { "description": "", @@ -86829,159 +87261,357 @@ "type": "integer" }, { - "description": "list networks by restartRequired", + "description": "List resources by tags (key/value pairs)", "length": 255, + "name": "tags", + "required": false, + "type": "map" + } + ], + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "response": [ + {}, + { + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" + }, + { + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" + }, + { + "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 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 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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" + }, + { + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" + }, + { + "description": "The IPv4 routing type of network", + "name": "ip4routing", + "type": "string" + }, + { + "description": "zone id of the network", + "name": "zoneid", + "type": "string" + }, + { + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" + }, + { + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", + "type": "string" + }, + { + "description": "the date this network was created", + "name": "created", + "type": "date" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", + "type": "string" + }, + { + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" + }, + { + "description": "the name of the network", + "name": "name", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the network's gateway", + "name": "gateway", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" + }, + { + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "related to what other network configuration", + "name": "related", + "type": "string" + }, + { + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", + "type": "string" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "type": "string" + }, + { + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "true network requires restart", "name": "restartrequired", - "required": false, "type": "boolean" - } - ], - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "response": [ + }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", + "type": "boolean" }, + {}, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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", - "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 domain name of the network owner", - "name": "domain", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", + "type": "string" }, { - "description": "the type of the network", - "name": "type", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "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 cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, - {}, { - "description": "the network domain", - "name": "networkdomain", + "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network domain", + "name": "networkdomain", + "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", + "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 public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the first IPv4 DNS for the network", + "name": "dns1", + "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the network's netmask", + "name": "netmask", + "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": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the type of the network", + "name": "type", "type": "string" }, { @@ -86989,39 +87619,32 @@ "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, - { - "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 provider name", - "name": "provider", - "response": [ + }, { "description": "services for this provider", "name": "servicelist", "type": "list" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -87030,177 +87653,51 @@ "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" }, { "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": "can this service capability value can be choosable while creatine network offerings", + "name": "canchooseservicecapability", "type": "boolean" }, { - "description": "the provider name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" - }, - { - "description": "the service name", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "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": "the domain associated with the tag", - "name": "domain", - "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": "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 project name where tag belongs to", - "name": "project", - "type": "string" - }, - { - "description": "id of the resource", - "name": "resourceid", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "type": "string" } ], "type": "list" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "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 IPv4 routing type of network", - "name": "ip4routing", - "type": "string" - }, - {}, - { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { @@ -87209,39 +87706,14 @@ "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": "ip6routes", - "type": "set" - }, - { - "description": "the displaytext of the network", - "name": "displaytext", - "type": "string" - }, - { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { "description": "network offering id the network is created from", @@ -87249,18 +87721,8 @@ "type": "string" }, { - "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", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { @@ -87269,99 +87731,69 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "The external id of the network", + "name": "externalid", "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "related to what other network configuration", - "name": "related", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", - "type": "string" - }, - { - "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 total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, - { - "description": "list networks that are persistent", - "name": "ispersistent", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "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 users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "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": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", + "type": "integer" } ] }, @@ -87382,8 +87814,13 @@ "response": [ {}, { - "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" }, { @@ -87391,16 +87828,11 @@ "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.17" @@ -87411,11 +87843,12 @@ "name": "updatePodManagementNetworkIpRange", "params": [ { - "description": "The new ending IP address.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "newendip", - "required": false, - "type": "string" + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", + "required": true, + "type": "uuid" }, { "description": "The current starting IP address.", @@ -87426,20 +87859,19 @@ "type": "string" }, { - "description": "The current ending IP address.", + "description": "The new ending IP address.", "length": 255, - "name": "currentendip", - "related": "listPods,createManagementNetworkIpRange", - "required": true, + "name": "newendip", + "required": false, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The current ending IP address.", "length": 255, - "name": "podid", + "name": "currentendip", "related": "listPods,createManagementNetworkIpRange", "required": true, - "type": "uuid" + "type": "string" }, { "description": "The new starting IP address.", @@ -87450,17 +87882,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", - "type": "integer" - }, {}, { "description": "true if operation is executed successfully", @@ -87471,6 +87892,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" } ], "since": "4.16.0.0" @@ -87498,6 +87930,22 @@ "related": "listOsCategories", "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": "Date when the OS category was created.", + "name": "created", + "type": "date" + }, { "description": "the name of the OS category", "name": "name", @@ -87508,11 +87956,6 @@ "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", @@ -87522,18 +87965,7 @@ "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - { - "description": "the ID of the OS category", - "name": "id", - "type": "string" - }, - { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" - }, - {} + } ], "since": "4.21.0" }, @@ -87546,7 +87978,7 @@ "description": "the ID of the firewall rule", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": true, "type": "uuid" }, @@ -87570,33 +88002,34 @@ "related": "createFirewallRule,listFirewallRules,updateEgressFirewallRule", "response": [ { - "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", + "description": "the starting port of firewall rule's port range", + "name": "startport", "type": "integer" }, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "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": "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 network id of the firewall rule", + "name": "networkid", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -87604,39 +88037,53 @@ "name": "destcidrlist", "type": "string" }, - {}, { - "description": "the state of the rule", - "name": "state", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "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", + "type": "integer" + }, + { + "description": "error code for this icmp message", + "name": "icmpcode", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -87645,74 +88092,59 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "list" }, { - "description": "the traffic type for the firewall rule", - "name": "traffictype", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the state of the rule", + "name": "state", "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": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" + "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", + "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 network id of the firewall rule", - "name": "networkid", - "type": "string" - } + {} ], "since": "4.4" }, @@ -87723,22 +88155,22 @@ "params": [], "related": "", "response": [ - {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "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" @@ -87758,28 +88190,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": "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" }, @@ -87791,42 +88223,42 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", + "description": "List by keyword", "length": 255, - "name": "templatetype", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List by type of the quota email template, allowed types: QUOTA_LOW, QUOTA_EMPTY", "length": 255, - "name": "pagesize", + "name": "templatetype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ { - "description": "Last date/time when template was updated", - "name": "last_updated", - "type": "date" + "description": "The quota email template subject", + "name": "templatesubject", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The quota email template locale", + "name": "locale", "type": "string" }, { @@ -87834,28 +88266,28 @@ "name": "jobstatus", "type": "integer" }, - {}, { - "description": "The quota email template locale", - "name": "locale", + "description": "Template type", + "name": "templatetype", "type": "string" }, { - "description": "The quota email template subject", - "name": "templatesubject", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Template type", - "name": "templatetype", + "description": "The quota email template content", + "name": "templatebody", "type": "string" }, {}, { - "description": "The quota email template content", - "name": "templatebody", - "type": "string" - } + "description": "Last date/time when template was updated", + "name": "last_updated", + "type": "date" + }, + {} ], "since": "4.7.0" }, @@ -87865,18 +88297,19 @@ "name": "createBgpPeer", "params": [ { - "description": "The password of the Bgp Peer.", + "description": "domain ID of the account owning the Bgp Peer", "length": 255, - "name": "password", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "account who will own the Bgp Peer", + "description": "The AS number of the Bgp Peer.", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "asnumber", + "required": true, + "type": "long" }, { "description": "The IPv4 address of the Bgp Peer.", @@ -87885,22 +88318,6 @@ "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, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, { "description": "The IPv6 address of the Bgp Peer.", "length": 255, @@ -87909,11 +88326,11 @@ "type": "string" }, { - "description": "BGP peer details in key/value pairs.", + "description": "account who will own the Bgp Peer", "length": 255, - "name": "details", + "name": "account", "required": false, - "type": "map" + "type": "string" }, { "description": "UUID of the zone which the Bgp Peer belongs to.", @@ -87924,58 +88341,63 @@ "type": "uuid" }, { - "description": "The AS number of the Bgp Peer.", + "description": "The password of the Bgp Peer.", "length": 255, - "name": "asnumber", - "required": true, - "type": "long" - } - ], - "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", - "response": [ - { - "description": "the project id of the bgp peer", - "name": "projectid", + "name": "password", + "required": false, "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "type": "string" + "description": "project who will own the Bgp Peer", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", - "type": "string" + "description": "BGP peer details in key/value pairs.", + "length": 255, + "name": "details", + "required": false, + "type": "map" + } + ], + "related": "listBgpPeers,dedicateBgpPeer,releaseBgpPeer", + "response": [ + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" }, { - "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": "the project name of the bgp peer", - "name": "project", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", + "description": "name of zone to which the bgp peer belongs to.", + "name": "zonename", "type": "string" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -87988,32 +88410,42 @@ "name": "jobid", "type": "string" }, - { - "description": "the domain name of the bgp peer", - "name": "domain", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "additional key/value details of the bgp peer", - "name": "details", - "type": "map" - }, - {}, { "description": "AS number of bgp peer", "name": "asnumber", "type": "long" }, + { + "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": "the project id of the bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "the account of the bgp peer", + "name": "account", + "type": "string" + }, + { + "description": "id of the bgp peer", + "name": "id", + "type": "string" + }, + { + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", + "type": "string" } ], "since": "4.20.0" @@ -88034,22 +88466,22 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "Hypervisor 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" } ] }, @@ -88066,6 +88498,13 @@ "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, @@ -88081,35 +88520,24 @@ "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": "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": "password of bgp peer", "name": "password", "type": "string" }, + {}, { - "description": "the account of the bgp peer", - "name": "account", - "type": "string" - }, - { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -88119,13 +88547,13 @@ }, {}, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "id of the bgp peer", + "name": "id", "type": "string" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, { @@ -88139,39 +88567,43 @@ "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "description": "the domain ID of the bgp peer", + "name": "domainid", "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 bgp peer", + "name": "projectid", + "type": "string" + }, + { + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, { "description": "AS number of bgp peer", "name": "asnumber", "type": "long" }, { - "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 domain name of the bgp peer", - "name": "domain", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "date when this bgp peer was created.", - "name": "created", - "type": "date" - }, - { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" } ], @@ -88183,40 +88615,34 @@ "name": "listHostsMetrics", "params": [ { - "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": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", + "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": "hypervisor", + "name": "resourcestate", "required": false, "type": "string" }, { - "description": "the id of the host", + "description": "lists hosts existing in particular cluster", "length": 255, - "name": "id", - "related": "declareHostAsDegraded,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, { - "description": "the state of the host", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "the host type", + "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", "length": 255, - "name": "type", + "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,createVMFromBackup,importVm", "required": false, - "type": "string" + "type": "uuid" }, { "description": "the Zone ID for the host", @@ -88227,69 +88653,75 @@ "type": "uuid" }, { - "description": "if true, list only hosts dedicated to HA", + "description": "the name of the storage access group", "length": 255, - "name": "hahost", + "name": "storageaccessgroup", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "lists hosts existing in particular cluster", + "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": "clusterid", - "related": "addCluster,updateCluster", + "name": "outofbandmanagementpowerstate", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists hosts in the same cluster as this VM and flag hosts with enough CPU/RAm to host this VM", + "description": "if true, list only hosts dedicated to HA", "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", + "name": "hahost", + "required": false, + "type": "boolean" + }, + { + "description": "the Pod ID for the host", + "length": 255, + "name": "podid", + "related": "listPods,createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the name of the storage access group", + "description": "the host type", "length": 255, - "name": "storageaccessgroup", + "name": "type", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "CPU Arch of the host", + "description": "", "length": 255, - "name": "arch", + "name": "page", "required": false, - "since": "4.20.1", - "type": "string" + "type": "integer" }, { - "description": "list hosts by its out-of-band management interface's power state. Its value can be one of [On, Off, Unknown]", + "description": "CPU Arch of the host", "length": 255, - "name": "outofbandmanagementpowerstate", + "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 for which out-of-band management is enabled", "length": 255, - "name": "resourcestate", + "name": "outofbandmanagementenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the name of the host", + "description": "hypervisor type of host: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator", "length": 255, - "name": "name", + "name": "hypervisor", "required": false, "type": "string" }, @@ -88303,121 +88735,106 @@ "type": "uuid" }, { - "description": "comma separated list of host details requested, value can be a list of [ min, all, capacity, events, stats]", + "description": "the state of the host", "length": 255, - "name": "details", + "name": "state", "required": false, - "type": "list" + "type": "string" }, { - "description": "list hosts for which out-of-band management is enabled", + "description": "the name of the host", "length": 255, - "name": "outofbandmanagementenabled", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the Pod ID for the host", + "description": "List by keyword", "length": 255, - "name": "podid", - "related": "listPods,createManagementNetworkIpRange", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the id of the host", "length": 255, - "name": "keyword", + "name": "id", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the host version", - "name": "version", - "type": "string" - }, - { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", "type": "boolean" }, { - "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": "the name of the host", - "name": "name", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "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 UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", - "type": "boolean" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "instances on the host", + "name": "instances", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocatedghz", + "description": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the total memory allocated in GiB", + "name": "memoryallocatedgb", "type": "string" }, + {}, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the total cpu used in Ghz", + "name": "cpuusedghz", + "type": "string" }, { - "description": "network write in GiB", - "name": "networkwrite", + "description": "the host version", + "name": "version", "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocatedghz", "type": "string" }, { @@ -88426,154 +88843,129 @@ "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "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 management server name of the host", + "name": "managementservername", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "the ID of the host", + "name": "id", "type": "string" }, { - "description": "the resource state of the host", - "name": "resourcestate", - "type": "string" + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" }, { - "description": "the total cpu used in Ghz", - "name": "cpuusedghz", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the cluster type of the cluster that host belongs to", - "name": "clustertype", + "description": "the OS category name of the host", + "name": "oscategoryname", "type": "string" }, { - "description": "the amount of the host's memory currently allocated", - "name": "memoryallocated", + "description": "the incoming network traffic on the host", + "name": "networkkbsread", "type": "long" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - }, - { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", - "type": "string" - }, - { - "description": "the Pod ID of the host", - "name": "podid", - "type": "string" + "description": "the host type", + "name": "type", + "type": "type" }, { - "description": "the total memory used in GiB", - "name": "memoryusedgb", + "description": "network read in GiB", + "name": "networkread", "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "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 amount of the host's CPU currently allocated", - "name": "cpuallocated", + "description": "the amount of the host's memory after applying the mem.overprovisioning.factor", + "name": "memorywithoverprovisioning", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the total memory capacity in GiB", + "name": "memorytotalgb", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" + "description": "the state of the host", + "name": "state", + "type": "status" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", "type": "boolean" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "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 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 CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", - "type": "long" + "description": "the total cpu capacity in Ghz", + "name": "cputotalghz", + "type": "string" }, { "description": "Host details in key/value pairs.", @@ -88581,44 +88973,40 @@ "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "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": "network read in GiB", - "name": "networkread", - "type": "string" + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", + "type": "long" }, + {}, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "network write in GiB", + "name": "networkwrite", "type": "string" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", "type": "string" }, { - "description": "the total memory allocated in GiB", - "name": "memoryallocatedgb", - "type": "string" + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" }, { - "description": "the total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" }, { "description": "the admin that annotated this host", @@ -88626,18 +89014,8 @@ "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", - "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 cluster name of the host", - "name": "clustername", + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { @@ -88646,88 +89024,74 @@ "type": "boolean" }, { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", - "type": "long" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", "type": "boolean" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", - "type": "boolean" + "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "type": "boolean" }, { - "description": "the cluster ID of the host", - "name": "clusterid", - "type": "string" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "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 host hypervisor", - "name": "hypervisor", + "description": "the total memory used in GiB", + "name": "memoryusedgb", "type": "string" }, + {}, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the IP address of the host", + "name": "ipaddress", + "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": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, - { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", - "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", @@ -88738,11 +89102,21 @@ "name": "videoram", "type": "long" }, + { + "description": "Maximum displays per user", + "name": "maxheads", + "type": "long" + }, { "description": "Maximum Y resolution per display", "name": "maxresolutiony", "type": "long" }, + { + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, { "description": "Maximum no. of vgpu per gpu card (pgpu)", "name": "maxvgpuperpgpu", @@ -88752,73 +89126,71 @@ "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", + "type": "long" } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", - "type": "string" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "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": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "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", + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", "type": "boolean" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "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 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", - "type": "string" + "description": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, - {}, { - "description": "the total cpu capacity in Ghz", - "name": "cputotalghz", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "system vm instances on the host", - "name": "systeminstances", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + { + "description": "the cluster ID of the host", + "name": "clusterid", "type": "string" }, { - "description": "instances on the host", - "name": "instances", + "description": "events available for the host", + "name": "events", "type": "string" }, { @@ -88827,13 +89199,23 @@ "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" + "description": "the name of the host", + "name": "name", + "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "the Pod name of the host", + "name": "podname", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", + "type": "string" + }, + { + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { @@ -88842,13 +89224,28 @@ "type": "boolean" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the total memory capacity in GiB", - "name": "memorytotalgb", + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", "type": "string" }, { @@ -88856,20 +89253,55 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "description": "the last time this host was annotated", + "name": "lastannotated", + "type": "date" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, { "description": "out-of-band management power state", "name": "powerstate", "type": "powerstate" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "system vm instances on the host", + "name": "systeminstances", + "type": "string" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" } ], "since": "4.9.3" @@ -88890,26 +89322,26 @@ ], "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" } ] }, @@ -88919,26 +89351,25 @@ "name": "listAffinityGroups", "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": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists affinity groups by name", + "description": "", "length": 255, - "name": "name", + "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": "lists affinity groups by name", "length": 255, - "name": "isrecursive", + "name": "name", "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.", @@ -88948,27 +89379,13 @@ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "lists affinity groups by virtual machine ID", + "description": "list the affinity group by the ID provided", "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", + "name": "id", + "related": "createAffinityGroup,listAffinityGroups", "required": false, "type": "uuid" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, @@ -88978,18 +89395,26 @@ "type": "uuid" }, { - "description": "lists affinity groups by type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "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": "lists affinity groups by virtual machine ID", + "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,createVMFromBackup,importVm", + "required": false, + "type": "uuid" }, { "description": "", @@ -88999,42 +89424,60 @@ "type": "integer" }, { - "description": "list the affinity group by the ID provided", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createAffinityGroup,listAffinityGroups", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "lists affinity groups by type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "related": "createAffinityGroup", "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 account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "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", @@ -89045,41 +89488,30 @@ "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", "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 type of the affinity group", - "name": "type", + "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 description of the affinity group", + "name": "description", "type": "string" }, - {}, { "description": "the ID of the affinity group", "name": "id", "type": "string" - }, - { - "description": "the project name of the affinity group", - "name": "project", - "type": "string" } ] }, @@ -89099,32 +89531,12 @@ ], "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 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 maintenance has been initiated", "name": "maintenanceinitiated", @@ -89136,20 +89548,40 @@ "type": "state" }, { - "description": "The host agents this management server is responsible for", - "name": "agents", - "type": "list" + "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 CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { "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 host agents this management server is responsible for", + "name": "agents", + "type": "list" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" } ], "since": "4.19.0" @@ -89159,13 +89591,6 @@ "isasync": false, "name": "registerSSHKeyPair", "params": [ - { - "description": "Public key material of the keypair", - "length": 5120, - "name": "publickey", - "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, @@ -89174,14 +89599,6 @@ "required": false, "type": "uuid" }, - { - "description": "an optional project for the ssh key", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, { "description": "Name of the keypair", "length": 255, @@ -89189,36 +89606,51 @@ "required": true, "type": "string" }, + { + "description": "Public key material of the keypair", + "length": 5120, + "name": "publickey", + "required": true, + "type": "string" + }, { "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, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" } ], "related": "listSSHKeyPairs", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the owner of the keypair", + "name": "account", "type": "string" }, {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain name of the keypair owner", - "name": "domain", + "description": "ID of the ssh keypair", + "name": "id", "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", + "type": "string" }, {}, { @@ -89227,23 +89659,23 @@ "type": "string" }, { - "description": "the project id of the keypair owner", - "name": "projectid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner of the keypair", - "name": "account", + "description": "the domain id of the keypair owner", + "name": "domainid", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "description": "the domain name of the keypair owner", + "name": "domain", "type": "string" }, { - "description": "ID of the ssh keypair", - "name": "id", + "description": "the project id of the keypair owner", + "name": "projectid", "type": "string" }, { @@ -89263,55 +89695,55 @@ "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 Quota usage type used to validate the activation rule.", "length": 255, "name": "usagetype", "required": true, "type": "integer" + }, + { + "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" } ], "related": "", "response": [ + { + "description": "Whether the activation rule is valid.", + "name": "isvalid", + "type": "boolean" + }, { "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", "name": "jobid", "type": "string" }, + { + "description": "The validated activation rule.", + "name": "activationrule", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "Whether the activation rule is valid.", - "name": "isvalid", - "type": "boolean" - }, {}, { "description": "The Quota usage type used to validate the activation rule.", "name": "quotatype", "type": "string" - }, - { - "description": "The validated activation rule.", - "name": "activationrule", - "type": "string" - }, - {} + } ], "since": "4.20.0" }, @@ -89321,10 +89753,17 @@ "name": "reserveIpAddress", "params": [ { - "description": "the ID of the domain to reserve with this IP address", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "fordisplay", + "required": false, + "type": "boolean" + }, + { + "description": "the ID of the project to reserve with this IP address", + "length": 255, + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, @@ -89337,20 +89776,13 @@ "type": "uuid" }, { - "description": "the ID of the project to reserve with this IP address", + "description": "the ID of the domain to reserve with this IP address", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "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", "length": 255, @@ -89361,34 +89793,19 @@ ], "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": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" - }, - { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "is public ip for display to the regular user", - "name": "fordisplay", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { @@ -89397,59 +89814,39 @@ "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" - }, - { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "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", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, - { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, { "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" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "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": "the name of the Network where ip belongs to", - "name": "networkname", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the name of the Network associated with the IP address", @@ -89457,104 +89854,104 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", - "type": "string" + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "true if this ip is system ip (was allocated as a part of deployVm or createLbRule)", - "name": "issystem", + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", "type": "boolean" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "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", + "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 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": "VPC name the ip belongs to", "name": "vpcname", "type": "string" }, + {}, { - "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 virtual network for the IP address", - "name": "forvirtualnetwork", + "description": "is public ip for display to the regular user", + "name": "fordisplay", "type": "boolean" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, - { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", - "type": "boolean" - }, { "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", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, {}, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, + { + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", + "type": "boolean" + }, { "description": "the list of resource tags associated with ip address", "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": "id of the resource", - "name": "resourceid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -89563,13 +89960,13 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -89578,8 +89975,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -89588,37 +89990,67 @@ "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" + }, + { + "description": "tag value", + "name": "value", + "type": "string" } ], "type": "list" }, + { + "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 this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "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": "date the public IP address was acquired", + "name": "allocated", + "type": "date" + }, { "description": "public IP address", "name": "ipaddress", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "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" } ], "since": "4.17" @@ -89629,11 +90061,11 @@ "name": "deleteEvents", "params": [ { - "description": "delete by event type", + "description": "start date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", "length": 255, - "name": "type", + "name": "startdate", "required": false, - "type": "string" + "type": "date" }, { "description": "end date range to delete events (including) this date (use format \"yyyy-MM-dd\" or the new format \"yyyy-MM-ddThh:mm:ss\")", @@ -89642,13 +90074,6 @@ "required": false, "type": "date" }, - { - "description": "start date range to delete events (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 events", "length": 255, @@ -89656,13 +90081,21 @@ "related": "", "required": false, "type": "list" + }, + { + "description": "delete by event type", + "length": 255, + "name": "type", + "required": false, + "type": "string" } ], "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", @@ -89670,17 +90103,16 @@ "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + } ] }, { @@ -89689,23 +90121,33 @@ "name": "deleteIso", "params": [ { - "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", + "description": "the ID of the ISO file", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, + "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 the ISO file", + "description": "the ID of the zone of the ISO file. If not specified, the ISO will be deleted from all the zones", "length": 255, - "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, + "name": "zoneid", + "related": "listZones", + "required": false, "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", @@ -89717,17 +90159,7 @@ "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" - } + {} ] }, { @@ -89735,13 +90167,6 @@ "isasync": false, "name": "listVPCOfferings", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -89750,13 +90175,11 @@ "type": "integer" }, { - "description": "list VPC offerings available for VPC creation in specific domain", + "description": "list VPC offerings by state", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "state", "required": false, - "since": "4.18", - "type": "uuid" + "type": "string" }, { "description": "id of zone VPC offering is associated with", @@ -89767,13 +90190,6 @@ "since": "4.13", "type": "uuid" }, - { - "description": "list VPC offerings by display text", - "length": 255, - "name": "displaytext", - "required": false, - "type": "string" - }, { "description": "true if need to list only default VPC offerings. Default value is false", "length": 255, @@ -89782,19 +90198,27 @@ "type": "boolean" }, { - "description": "", + "description": "list VPC offerings by id", "length": 255, - "name": "page", + "name": "id", + "related": "updateVPCOffering,listVPCOfferings", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list VPC offerings by state", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, + { + "description": "list VPC offerings supporting certain services", + "length": 255, + "name": "supportedservices", + "required": false, + "type": "list" + }, { "description": "list VPC offerings by name", "length": 255, @@ -89803,59 +90227,124 @@ "type": "string" }, { - "description": "list VPC offerings supporting certain services", + "description": "list VPC offerings by display text", "length": 255, - "name": "supportedservices", + "name": "displaytext", "required": false, - "type": "list" + "type": "string" }, { - "description": "list VPC offerings by id", + "description": "", "length": 255, - "name": "id", - "related": "updateVPCOffering,listVPCOfferings", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "list VPC offerings available for VPC creation in specific domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, + "since": "4.18", "type": "uuid" } ], "related": "updateVPCOffering", "response": [ - { - "description": " indicates if the vpc offering supports distributed router for one-hop forwarding", - "name": "distributedvpcrouter", - "type": "boolean" - }, + {}, { "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", "name": "networkmode", "type": "string" }, { - "description": "the date this vpc 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", + "type": "string" + }, + {}, + { + "description": "the id of the vpc offering", + "name": "id", + "type": "string" + }, + { + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {}, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "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.", - "name": "displaytext", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "type": "string" + }, + { + "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": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the name of the vpc offering", + "name": "name", "type": "string" }, - {}, { "description": "the list of supported services", "name": "service", "response": [ + { + "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", @@ -89866,19 +90355,14 @@ "name": "provider", "response": [ { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "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 destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the provider name", @@ -89886,9 +90370,9 @@ "type": "string" }, { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "uuid of the network provider", + "name": "id", + "type": "string" }, { "description": "the physical network this belongs to", @@ -89896,31 +90380,14 @@ "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": "the capability value", - "name": "value", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", - "name": "name", + "description": "state of the network provider", + "name": "state", "type": "string" - }, - { - "description": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" } ], "type": "list" @@ -89929,8 +90396,13 @@ "type": "list" }, { - "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": "state of the vpc offering. Can be Disabled/Enabled", + "name": "state", "type": "string" }, { @@ -89939,13 +90411,8 @@ "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", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { @@ -89953,45 +90420,10 @@ "name": "fornsx", "type": "boolean" }, - { - "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": "indicated if the offering can support region level vpc", - "name": "supportsregionLevelvpc", - "type": "boolean" - }, - { - "description": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "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": "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" } ] }, @@ -90010,23 +90442,23 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "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" }, - {}, - {} + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ] }, { @@ -90035,25 +90467,27 @@ "name": "uploadVolume", "params": [ { - "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", + "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", "length": 255, - "name": "format", - "required": true, - "type": "string" + "name": "diskofferingid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the URL of where the volume is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the name of the volume", + "length": 255, + "name": "name", "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.", + "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": "checksum", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Upload volume for the project", @@ -90064,12 +90498,18 @@ "type": "uuid" }, { - "description": "the ID of the disk offering. This must be a custom sized offering since during uploadVolume volume size is unknown.", + "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, - "name": "diskofferingid", - "related": "", + "name": "checksum", "required": false, - "type": "uuid" + "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": "an optional accountName. Must be used with domainId.", @@ -90078,14 +90518,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the zone the volume is to be hosted on", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, { "description": "Image store uuid", "length": 255, @@ -90094,27 +90526,27 @@ "type": "string" }, { - "description": "the name of the volume", + "description": "the format for the volume. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "name", + "name": "format", "required": true, "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": "the ID of the zone the volume is to be hosted on", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "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 chain info of the volume", - "name": "chaininfo", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { "description": "the display text of the disk offering", @@ -90122,23 +90554,28 @@ "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -90146,109 +90583,125 @@ "name": "physicalsize", "type": "long" }, + { + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, { "description": "max iops of the disk volume", "name": "maxiops", "type": "long" }, { - "description": "the bytes allocated", - "name": "virtualsize", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + {}, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "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": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "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": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "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": "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", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { @@ -90257,99 +90710,98 @@ "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "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": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, { "description": "cluster name where the volume is allocated", "name": "clustername", "type": "string" }, { - "description": "the status of the volume", - "name": "status", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "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": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "the chain info of the volume", + "name": "chaininfo", + "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -90358,14 +90810,14 @@ "type": "string" }, { - "description": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "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": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { "description": "path of the Domain the disk volume belongs to", @@ -90373,19 +90825,13 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, - {}, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { @@ -90393,36 +90839,6 @@ "name": "volumerepairresult", "type": "map" }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" - }, - { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "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 format of the disk encryption if applicable", - "name": "encryptformat", - "type": "string" - }, - { - "description": "the state of the disk volume", - "name": "state", - "type": "string" - }, { "description": "the domain associated with the disk volume", "name": "domain", @@ -90433,48 +90849,49 @@ "name": "destroyed", "type": "boolean" }, + {}, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "the path of the volume", + "name": "path", "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 date the disk volume was created", - "name": "created", - "type": "date" + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 status of the volume", + "name": "status", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -90483,33 +90900,33 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { @@ -90521,19 +90938,34 @@ "type": "set" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "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": "cluster id of the volume", - "name": "clusterid", + "description": "name of the disk offering", + "name": "diskofferingname", + "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" } ] }, @@ -90542,6 +90974,13 @@ "isasync": false, "name": "configureOutOfBandManagement", "params": [ + { + "description": "the host management interface user", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "the host management interface driver, for example: ipmitool", "length": 255, @@ -90557,9 +90996,9 @@ "type": "string" }, { - "description": "the host management interface user", + "description": "the host management interface password", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -90577,30 +91016,18 @@ "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" - }, - { - "description": "the host management interface password", - "length": 255, - "name": "password", - "required": true, - "type": "string" } ], "related": "enableOutOfBandManagementForHost,changeOutOfBandManagementPassword", "response": [ { - "description": "the out-of-band management driver for the host", - "name": "driver", - "type": "string" - }, - { - "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 ID of the host", - "name": "hostid", + "description": "the out-of-band management driver for the host", + "name": "driver", "type": "string" }, {}, @@ -90610,19 +91037,20 @@ "type": "string" }, { - "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" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the out-of-band management interface username", + "name": "username", "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", @@ -90635,26 +91063,30 @@ "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 operation result description", - "name": "description", + "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 action (if issued)", + "name": "action", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the operation result description", + "name": "description", + "type": "string" }, - {} + { + "description": "the operation result", + "name": "status", + "type": "boolean" + } ], "since": "4.9.0" }, @@ -90664,18 +91096,18 @@ "name": "listStorageTags", "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": "", @@ -90687,13 +91119,22 @@ ], "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 ID of the storage tag", + "name": "id", + "type": "string" + }, { "description": "the name of the storage tag", "name": "name", @@ -90704,93 +91145,108 @@ "name": "poolid", "type": "long" }, - { - "description": "the ID of the storage tag", - "name": "id", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - } + {} ] }, { - "description": "Creates a IPv4 subnet for guest networks.", - "isasync": true, - "name": "createIpv4SubnetForGuestNetwork", + "description": "Delete VM Schedule.", + "isasync": false, + "name": "deleteVMSchedule", "params": [ { - "description": "the CIDR size of IPv4 network. This is mutually exclusive with subnet.", + "description": "IDs of VM schedule", "length": 255, - "name": "cidrsize", + "name": "ids", + "related": "", "required": false, - "type": "integer" + "type": "list" }, { - "description": "The CIDR of this Ipv4 subnet.", + "description": "ID of VM", "length": 255, - "name": "subnet", - "required": false, - "type": "string" + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" }, { - "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", + "description": "ID of VM schedule", "length": 255, - "name": "parentid", - "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", - "required": true, + "name": "id", + "related": "", + "required": false, "type": "uuid" } ], - "related": "", "response": [ + {}, { - "description": "date when this IPv4 subnet was removed.", - "name": "removed", - "type": "date" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" }, { - "description": "name of network which the IPv4 subnet is associated with.", - "name": "networkname", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, {}, { - "description": "date when this IPv4 subnet was allocated.", - "name": "allocated", - "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" - }, + } + ], + "since": "4.19.0" + }, + { + "description": "Creates a IPv4 subnet for guest networks.", + "isasync": true, + "name": "createIpv4SubnetForGuestNetwork", + "params": [ { - "description": "id of network which the IPv4 subnet is associated with.", - "name": "networkid", - "type": "string" + "description": "The zone Ipv4 subnet which the IPv4 subnet belongs to.", + "length": 255, + "name": "parentid", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": true, + "type": "uuid" }, { - "description": "subnet of the data center IPv4 subnet", - "name": "parentsubnet", + "description": "The CIDR of this Ipv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "id of the data center IPv4 subnet", - "name": "parentid", + "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 IPv4 network", + "name": "subnet", "type": "string" }, - {}, { - "description": "Id of the VPC which the IPv4 subnet is associated with.", - "name": "vpcid", - "type": "string" + "description": "date when this IPv4 subnet was allocated.", + "name": "allocated", + "type": "date" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zoneid", + "description": "state of subnet of the IPv4 network", + "name": "state", "type": "string" }, { @@ -90804,13 +91260,13 @@ "type": "string" }, { - "description": "state of subnet of the IPv4 network", - "name": "state", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "subnet of the IPv4 network", - "name": "subnet", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { @@ -90819,73 +91275,49 @@ "type": "date" }, { - "description": "id of the IPv4 subnet for guest network", - "name": "id", + "description": "id of network which the IPv4 subnet is associated with.", + "name": "networkid", "type": "string" }, { - "description": "id of zone to which the IPv4 subnet belongs to.", - "name": "zonename", + "description": "subnet of the data center IPv4 subnet", + "name": "parentsubnet", "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Delete VM Schedule.", - "isasync": false, - "name": "deleteVMSchedule", - "params": [ - { - "description": "ID of VM schedule", - "length": 255, - "name": "id", - "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" - } - ], - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the VPC which the IPv4 subnet is associated with.", + "name": "vpcid", "type": "string" }, {}, { - "description": "any text associated with the success or failure", - "name": "displaytext", + "description": "name of network which the IPv4 subnet is associated with.", + "name": "networkname", "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 IPv4 subnet for guest network", + "name": "id", + "type": "string" + }, + { + "description": "date when this IPv4 subnet was removed.", + "name": "removed", + "type": "date" + }, + { + "description": "id of the data center IPv4 subnet", + "name": "parentid", + "type": "string" } ], - "since": "4.19.0" + "since": "4.20.0" }, { "description": "List template visibility and all accounts that have permissions to view this template.", @@ -90903,7 +91335,6 @@ ], "related": "listIsoPermissions,listTemplatePermissions,listIsoPermissions", "response": [ - {}, { "description": "the list of projects the template is available for", "name": "projectids", @@ -90914,16 +91345,22 @@ "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 list of accounts the template is available for", + "name": "account", + "type": "list" + }, + { + "description": "the template ID", + "name": "id", + "type": "string" + }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", @@ -90934,12 +91371,7 @@ "name": "jobid", "type": "string" }, - {}, - { - "description": "the list of accounts the template is available for", - "name": "account", - "type": "list" - } + {} ] }, { @@ -90948,16 +91380,9 @@ "name": "listAnnotations", "params": [ { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "the id of the annotation", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, "type": "string" }, @@ -90969,54 +91394,71 @@ "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": "the entity type", "length": 255, - "name": "annotationfilter", + "name": "entitytype", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "optional: the id of the user of the annotation", + "description": "the id of the annotation", "length": 255, - "name": "userid", + "name": "id", "required": false, - "since": "4.16.0", "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the entity type", + "description": "optional: the id of the user of the annotation", "length": 255, - "name": "entitytype", + "name": "userid", "required": false, + "since": "4.16.0", "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" + }, + { + "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": "annotationfilter", + "required": false, + "since": "4.16.0", + "type": "string" } ], "related": "addAnnotation", "response": [ { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", + "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": "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "the type of the annotated entity", @@ -91024,51 +91466,41 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The username of the user that entered the annotation", + "name": "username", "type": "string" }, { - "description": "the (uu)id of the entity to which this annotation pertains", - "name": "entityid", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "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" }, { "description": "the removal timestamp for this annotation", "name": "removed", "type": "date" }, - {}, - {}, { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + {}, + {}, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the (uu)id of the annotation", + "name": "id", "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" @@ -91085,13 +91517,6 @@ "required": false, "type": "string" }, - { - "description": "the account for swift", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "the URL for swift", "length": 255, @@ -91105,81 +91530,88 @@ "name": "key", "required": false, "type": "string" + }, + { + "description": "the account for swift", + "length": 255, + "name": "account", + "required": false, + "type": "string" } ], "related": "addSecondaryStorage,listSwifts,addImageStore", "response": [ { - "description": "the name of the image store", - "name": "name", + "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 name of the image store", + "name": "name", + "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "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 host's currently used disk size", + "name": "disksizeused", + "type": "long" }, { - "description": "the Zone name of the image store", - "name": "zonename", + "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 host's currently used disk size", - "name": "disksizeused", - "type": "long" - }, { "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", + "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 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 ID of the image store", - "name": "id", - "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 total disk size of the host", + "name": "disksizetotal", + "type": "long" } ], "since": "3.0.0" @@ -91190,9 +91622,9 @@ "name": "updateVgpuProfile", "params": [ { - "description": "the maximum Y resolution", + "description": "the maximum X resolution", "length": 255, - "name": "maxresolutiony", + "name": "maxresolutionx", "required": false, "type": "long" }, @@ -91203,14 +91635,6 @@ "required": false, "type": "string" }, - { - "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, @@ -91218,13 +91642,6 @@ "required": false, "type": "long" }, - { - "description": "the description of the vGPU profile", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "the maximum number of display heads", "length": 255, @@ -91232,6 +91649,14 @@ "required": false, "type": "long" }, + { + "description": "the ID of the vGPU profile", + "length": 255, + "name": "id", + "related": "createVgpuProfile,updateVgpuProfile", + "required": true, + "type": "uuid" + }, { "description": "the video RAM size in MB", "length": 255, @@ -91240,30 +91665,43 @@ "type": "long" }, { - "description": "the maximum X resolution", + "description": "the description of the vGPU profile", "length": 255, - "name": "maxresolutionx", + "name": "description", + "required": false, + "type": "string" + }, + { + "description": "the maximum Y resolution", + "length": 255, + "name": "maxresolutiony", "required": false, "type": "long" } ], "related": "createVgpuProfile", "response": [ + { + "description": "the vendor name of the GPU card", + "name": "vendorname", + "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", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "the name of the vGPU profile", "name": "gpucardname", "type": "string" }, + {}, { "description": "the vendor ID of the GPU card", "name": "vendorid", @@ -91275,36 +91713,45 @@ "type": "string" }, { - "description": "the ID of the GPU card associated with this vGPU profile", - "name": "gpucardid", + "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 device ID of the GPU card", + "name": "deviceid", + "type": "string" + }, + { + "description": "the display name of the GPU card", + "name": "name", + "type": "string" }, { "description": "the maximum number of vGPUs per physical GPU", "name": "maxvgpuperphysicalgpu", "type": "long" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, { "description": "the ID of the GPU card", "name": "id", "type": "string" }, - {}, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", "type": "string" }, {}, { - "description": "the device ID of the GPU card", - "name": "deviceid", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { "description": "the device name of the GPU card", @@ -91312,24 +91759,9 @@ "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.21.0" @@ -91340,19 +91772,41 @@ "name": "listSnapshotPolicies", "params": [ { - "description": "the ID of the snapshot policy", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "id", - "related": "updateSnapshotPolicy,listSnapshotPolicies", + "name": "fordisplay", + "required": false, + "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" }, { - "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": "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, + "name": "account", + "required": false, + "type": "string" }, { "description": "List by keyword", @@ -91361,86 +91815,80 @@ "required": false, "type": "string" }, + { + "description": "the ID of the snapshot policy", + "length": 255, + "name": "id", + "related": "updateSnapshotPolicy,listSnapshotPolicies", + "required": false, + "type": "uuid" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fordisplay", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk volume", + "description": "", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "updateSnapshotPolicy", "response": [ + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "The list of pools in which snapshot backup is scheduled", "name": "storage", "type": "set" }, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "description": "the ID of the disk volume", - "name": "volumeid", - "type": "string" - }, - { - "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 snapshot policy", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "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": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "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": "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" }, { @@ -91449,67 +91897,93 @@ "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": "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" }, { - "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 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": "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": "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" } ], "type": "set" }, { - "description": "is this policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "The list of zones in which snapshot backup is scheduled", + "name": "zone", + "type": "set" + }, + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "maximum number of snapshots retained", + "name": "maxsnaps", + "type": "int" + }, + { + "description": "the time zone of the snapshot policy", + "name": "timezone", + "type": "string" + }, + { + "description": "the ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "time the snapshot is scheduled to be taken.", + "name": "schedule", + "type": "string" }, + {}, { "description": "the interval type of the snapshot policy", "name": "intervaltype", "type": "short" }, { - "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" } ] }, @@ -91518,6 +91992,14 @@ "isasync": true, "name": "updateVpnCustomerGateway", "params": [ + { + "description": "id of customer gateway", + "length": 255, + "name": "id", + "related": "updateVpnCustomerGateway", + "required": true, + "type": "uuid" + }, { "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", "length": 255, @@ -91527,47 +92009,55 @@ "type": "boolean" }, { - "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": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "ikeversion", + "name": "esplifetime", "required": false, - "since": "4.15.1", - "type": "string" + "type": "long" }, { - "description": "public ip address id of the customer gateway", + "description": "ESP policy of the customer gateway", "length": 255, - "name": "gateway", + "name": "esppolicy", "required": true, "type": "string" }, { - "description": "IKE policy of the customer gateway", + "description": "guest cidr of the customer gateway. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "ikepolicy", + "name": "cidrlist", "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": "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": "ikelifetime", + "name": "ikeversion", "required": false, - "type": "long" + "since": "4.15.1", + "type": "string" }, { - "description": "Lifetime of phase 2 VPN connection to the customer gateway, in seconds", + "description": "If DPD is enabled for VPN connection", "length": 255, - "name": "esplifetime", + "name": "dpd", "required": false, - "type": "long" + "type": "boolean" + }, + { + "description": "public ip address id of the customer gateway", + "length": 255, + "name": "gateway", + "required": true, + "type": "string" }, { "description": "Force encapsulation for Nat Traversal", @@ -91591,12 +92081,11 @@ "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.", + "description": "Lifetime of phase 1 VPN connection to the customer gateway, in seconds", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "ikelifetime", "required": false, - "type": "uuid" + "type": "long" }, { "description": "the account associated with the gateway. Must be used with the domainId parameter.", @@ -91606,24 +92095,9 @@ "type": "string" }, { - "description": "ESP policy of the customer gateway", - "length": 255, - "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 (,).", + "description": "IKE policy of the customer gateway", "length": 255, - "name": "cidrlist", + "name": "ikepolicy", "required": true, "type": "string" } @@ -91631,23 +92105,13 @@ "related": "", "response": [ { - "description": "IKE policy of customer gateway", - "name": "ikepolicy", - "type": "string" - }, - { - "description": "Lifetime of ESP SA of customer gateway", - "name": "esplifetime", - "type": "long" - }, - { - "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": "the project id", - "name": "projectid", + "description": "IPsec policy of customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -91656,9 +92120,9 @@ "type": "boolean" }, { - "description": "guest cidr list of the customer gateway. 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": "the domain id of the owner", @@ -91671,54 +92135,53 @@ "type": "string" }, { - "description": "name of the customer gateway", - "name": "name", + "description": "the project id", + "name": "projectid", "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, { - "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 vpn gateway ID", "name": "id", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the owner", + "name": "account", + "type": "string" }, { - "description": "IPsec policy of 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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "the owner", - "name": "account", + "description": "IKE policy of customer gateway", + "name": "ikepolicy", "type": "string" }, { @@ -91726,31 +92189,42 @@ "name": "project", "type": "string" }, - {}, { - "description": "guest ip of the customer gateway", - "name": "ipaddress", + "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 ip of the customer gateway", + "name": "ipaddress", + "type": "string" }, + {}, { - "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": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", - "name": "splitconnections", - "type": "boolean" + "description": "name of the customer gateway", + "name": "name", + "type": "string" }, + {}, { "description": "the domain name of the owner", "name": "domain", "type": "string" + }, + { + "description": "the domain path of the owner", + "name": "domainpath", + "type": "string" + }, + { + "description": "For IKEv2, whether to split multiple right subnet cidrs into multiple connection statements.", + "name": "splitconnections", + "type": "boolean" } ] }, @@ -91759,13 +92233,6 @@ "isasync": true, "name": "applyTungstenFabricTag", "params": [ - { - "description": "the uuid of networks", - "length": 255, - "name": "networkuuid", - "required": false, - "type": "list" - }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -91781,17 +92248,24 @@ "type": "list" }, { - "description": "the uuid of Tungsten-Fabric application policy set", + "description": "the uuid of Tungsten-Fabric tag", "length": 255, - "name": "applicationpolicysetuuid", - "required": false, + "name": "taguuid", + "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric tag", + "description": "the uuid of nics", "length": 255, - "name": "taguuid", - "required": true, + "name": "nicuuid", + "required": false, + "type": "list" + }, + { + "description": "the uuid of Tungsten-Fabric application policy set", + "length": 255, + "name": "applicationpolicysetuuid", + "required": false, "type": "string" }, { @@ -91803,45 +92277,44 @@ "type": "uuid" }, { - "description": "the uuid of nics", + "description": "the uuid of networks", "length": 255, - "name": "nicuuid", + "name": "networkuuid", "required": false, "type": "list" } ], "related": "", "response": [ - {}, { "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": "list Tungsten-Fabric policy", "name": "policy", "type": "list" }, + {}, { "description": "Tungsten-Fabric tag type uuid", "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric tag name", - "name": "name", - "type": "string" - }, - {}, - { - "description": "list Tungsten-Fabric network", - "name": "network", + "description": "list Tungsten-Fabric vm", + "name": "vm", "type": "list" }, { - "description": "list Tungsten-Fabric vm", - "name": "vm", + "description": "list Tungsten-Fabric nic", + "name": "nic", "type": "list" }, { @@ -91850,19 +92323,20 @@ "type": "integer" }, { - "description": "list Tungsten-Fabric nic", - "name": "nic", + "description": "list Tungsten-Fabric network", + "name": "network", "type": "list" }, + { + "description": "Tungsten-Fabric tag 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" } ] }, @@ -91872,12 +92346,11 @@ "name": "updateObjectStoragePool", "params": [ { - "description": "Object Store ID", + "description": "the name for the object store", "length": 255, - "name": "id", - "related": "addObjectStoragePool,updateObjectStoragePool", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "the url for the object store", @@ -91886,6 +92359,14 @@ "required": false, "type": "string" }, + { + "description": "Object Store ID", + "length": 255, + "name": "id", + "related": "addObjectStoragePool,updateObjectStoragePool", + "required": true, + "type": "uuid" + }, { "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, @@ -91893,35 +92374,23 @@ "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 ID of the object store", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the provider name of the object store", - "name": "providername", + "description": "the name of the object store", + "name": "name", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the name of the object store", - "name": "name", + "description": "the provider name of the object store", + "name": "providername", "type": "string" }, { @@ -91930,31 +92399,36 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the url of the object store", + "name": "url", "type": "string" }, - {}, - { - "description": "the total size of the object store", - "name": "storagetotal", - "type": "long" - }, - {}, { "description": "the allocated size of the object store", "name": "storageallocated", "type": "long" }, + { + "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 url of the object store", - "name": "url", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + {}, + { + "description": "the total size of the object store", + "name": "storagetotal", + "type": "long" } ], "since": "4.19.0" @@ -91964,6 +92438,13 @@ "isasync": false, "name": "registerExtension", "params": [ + { + "description": "ID of the resource to register the extension with", + "length": 255, + "name": "resourceid", + "required": true, + "type": "string" + }, { "description": "ID of the extension", "length": 255, @@ -91973,9 +92454,9 @@ "type": "uuid" }, { - "description": "ID of the resource to register the extension with", + "description": "Type of the resource", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": true, "type": "string" }, @@ -91985,68 +92466,45 @@ "name": "details", "required": false, "type": "map" - }, - { - "description": "Type of the resource", - "length": 255, - "name": "resourcetype", - "required": true, - "type": "string" } ], "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "response": [ { - "description": "The details of the extension", - "name": "details", - "type": "map" + "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 extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { - "description": "Type of the extension", - "name": "type", - "type": "string" + "description": "The details of the extension", + "name": "details", + "type": "map" }, { - "description": "ID of the extension", - "name": "id", + "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": "The state of the extension", - "name": "state", + "description": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "Description of the extension", - "name": "description", + "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": "Type of the resource", - "name": "type", - "type": "string" - }, { "description": "the details of the resource map", "name": "details", @@ -92061,40 +92519,56 @@ "description": "Creation timestamp of the mapping", "name": "created", "type": "date" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" } ], "type": "list" }, { - "description": "Name of the extension", - "name": "name", - "type": "string" + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { - "description": "The path of the entry point fo the extension", - "name": "path", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" + "description": "Type of the extension", + "name": "type", + "type": "string" }, {}, { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", + "description": "True if the extension is added by admin", + "name": "isuserdefined", "type": "boolean" }, { - "description": "Creation timestamp of the extension", - "name": "created", + "description": "The path of the entry point fo the extension", + "name": "path", + "type": "string" + }, + {}, + { + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", "type": "date" }, { - "description": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.21.0" @@ -92123,169 +92597,123 @@ "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 total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" - }, - { - "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", - "name": "vmavailable", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "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) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, - {}, { - "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 name of the account", - "name": "name", - "type": "string" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "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 backups which can be stored by this account", - "name": "backuplimit", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" + "description": "the date when this account was created", + "name": "created", + "type": "date" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "description": "the user lastname", - "name": "lastname", - "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", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user firstname", + "name": "firstname", "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 ID of the role", - "name": "roleid", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the boolean value representing if the updating target is in caller's child domain", + "name": "iscallerchilddomain", + "type": "boolean" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, - { - "description": "the user name", - "name": "username", + "description": "the user lastname", + "name": "lastname", "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 name of the role", @@ -92293,173 +92721,183 @@ "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", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "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 domain name of the user", + "name": "domain", + "type": "string" }, { - "description": "the source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", - "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 timezone user was created in", - "name": "timezone", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "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 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 user state", + "name": "state", + "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the ID of the role", + "name": "roleid", "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 api key of the user", - "name": "apikey", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" } ], "type": "list" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" }, { - "description": "id of the Domain the account belongs to", - "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 total number of projects the account can own", - "name": "projectlimit", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, {}, + { + "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) 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 public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "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) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "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 object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "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 buckets available to this account", - "name": "bucketavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "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 total number of buckets which can be stored by this account", - "name": "bucketlimit", - "type": "string" + "description": "the total number of cpu cores owned by account", + "name": "cputotal", + "type": "long" }, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" }, { "description": "Base64 string representation of the resource icon", @@ -92467,14 +92905,14 @@ "type": "resourceiconresponse" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { "description": "the total number of templates which can be created by this account", @@ -92482,38 +92920,53 @@ "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the id of the account", - "name": "id", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { @@ -92522,33 +92975,33 @@ "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", + "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 number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { @@ -92556,89 +93009,110 @@ "name": "primarystoragelimit", "type": "string" }, + {}, { - "description": "the state of the account", - "name": "state", + "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", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "the total number of networks the account can own", + "name": "networklimit", + "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": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" }, { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", + "type": "string" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "description": "the total number of buckets available to this account", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", - "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", - "name": "rolename", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" + }, + { + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of networks owned by account", + "name": "networktotal", + "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", + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", - "type": "long" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -92667,8 +93141,33 @@ "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs,stopNetScalerVpx", "response": [ { - "description": "the domain associated with the router", - "name": "domain", + "description": "the version of scripts", + "name": "scriptsversion", + "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 control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -92677,39 +93176,58 @@ "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the host ID for the router", + "name": "hostid", "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 list of nics associated with the router", "name": "nic", "response": [ { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ip address of the nic", + "name": "ipaddress", "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": "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "public IP address id associated with this nic via Static nat rule", @@ -92717,38 +93235,33 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 ID of the nic", - "name": "id", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { @@ -92757,48 +93270,53 @@ "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the name of the corresponding network", + "name": "networkname", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "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 ID of the corresponding network", + "name": "networkid", "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 netmask of the nic", - "name": "netmask", - "type": "string" + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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" }, { @@ -92807,28 +93325,28 @@ "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": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -92837,26 +93355,21 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" } ], "type": "set" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { @@ -92865,53 +93378,86 @@ "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the network domain for the router", + "name": "networkdomain", "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 first IPv6 DNS for the router", - "name": "ip6dns1", - "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": "result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "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 ID of the corresponding guest network", - "name": "guestnetworkid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, + {}, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { @@ -92920,39 +93466,29 @@ "type": "string" }, { - "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": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" - }, - { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { "description": "CPU arch of the router", @@ -92960,182 +93496,125 @@ "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" - }, - { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the first DNS for the router", + "name": "dns1", "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": "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 Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "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 version of template", + "name": "version", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "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 ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", - "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", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "role of the domain router", - "name": "role", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" + "description": "the date and time the router 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 name of VPC the router belongs to", + "name": "vpcname", + "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "role of the domain router", + "name": "role", + "type": "string" } ] }, @@ -93154,27 +93633,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": "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], "since": "3.0.0" @@ -93185,18 +93664,12 @@ "name": "createTungstenFabricFirewallPolicy", "params": [ { - "description": "Tungsten-Fabric firewall policy name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "description": "the sequence of Tungsten-Fabric firewall policy", + "description": "the ID of zone", "length": 255, - "name": "sequence", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "integer" + "type": "uuid" }, { "description": "the uuid of Tungsten-Fabric application policy set", @@ -93206,53 +93679,59 @@ "type": "string" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric firewall policy name", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "the sequence of Tungsten-Fabric firewall policy", + "length": 255, + "name": "sequence", + "required": true, + "type": "integer" } ], "related": "", "response": [ - {}, { "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 name", - "name": "zonename", + "description": "Tungsten-Fabric firewall policy 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 firewall policy name", - "name": "name", - "type": "string" + "description": "list Tungsten-Fabric firewall rule", + "name": "firewallrule", + "type": "list" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" - } + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" + }, + {} ] }, { @@ -93285,25 +93764,20 @@ "related": "", "response": [ { - "description": "true if GSLB service is enabled in the region, false otherwise", - "name": "gslbserviceenabled", - "type": "boolean" - }, - {}, - { - "description": "true if security groups support is enabled, false otherwise", - "name": "portableipserviceenabled", - "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 end point of the region", + "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 region", + "name": "name", + "type": "string" }, { "description": "the ID of the region", @@ -93311,15 +93785,20 @@ "type": "integer" }, { - "description": "the end point of the region", - "name": "endpoint", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "portableipserviceenabled", + "type": "boolean" }, { - "description": "the name of the region", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "true if GSLB service is enabled in the region, false otherwise", + "name": "gslbserviceenabled", + "type": "boolean" + }, {} ] }, @@ -93338,21 +93817,21 @@ } ], "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" }, {}, { @@ -93368,13 +93847,6 @@ "isasync": true, "name": "destroySharedFileSystem", "params": [ - { - "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" - }, { "description": "the ID of the shared filesystem to delete", "length": 255, @@ -93389,30 +93861,37 @@ "name": "expunge", "required": false, "type": "boolean" + }, + { + "description": "If true is passed, the shared filesystem can be destroyed without stopping it first.", + "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": "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" } ], "since": "4.20.0" @@ -93442,20 +93921,8 @@ "related": "", "response": [ { - "description": "the description of the role permission", - "name": "description", - "type": "string" - }, - {}, - {}, - { - "description": "the ID of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the project role to which the role permission belongs", + "name": "projectrolename", "type": "string" }, { @@ -93468,24 +93935,36 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the ID of the project role permission", + "name": "id", + "type": "string" + }, { "description": "the ID of the project role to which the role permission belongs", "name": "projectroleid", "type": "string" }, { - "description": "the name of the project role to which the role permission belongs", - "name": "projectrolename", + "description": "the api name or wildcard rule", + "name": "rule", "type": "string" }, + {}, + {}, { - "description": "the ID of the project role permission", - "name": "id", + "description": "the description of the role permission", + "name": "description", "type": "string" }, { - "description": "the api name or wildcard rule", - "name": "rule", + "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" } ], @@ -93496,27 +93975,6 @@ "isasync": false, "name": "listLdapConfigurations", "params": [ - { - "description": "Port", - "length": 255, - "name": "port", - "required": false, - "type": "integer" - }, - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -93546,29 +94004,58 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "list ldap configuration by ID; when passed, all other parameters are ignored", + "length": 255, + "name": "id", + "related": "addLdapConfiguration,listLdapConfigurations", + "required": false, + "type": "uuid" + }, + { + "description": "Port", + "length": 255, + "name": "port", + "required": false, + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": false, + "type": "string" } ], "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", + "description": "the ID of the LDAP configuration", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "linked domain", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -93576,7 +94063,12 @@ "name": "hostname", "type": "string" }, - {} + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.2.0" }, @@ -93586,11 +94078,19 @@ "name": "createRemoteAccessVpn", "params": [ { - "description": "the range of ip addresses to allocate to vpn clients. The first ip in the range will be taken by the vpn server", + "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": "iprange", + "name": "openfirewall", "required": false, - "type": "string" + "type": "boolean" + }, + { + "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": "public ip address id of the vpn server", @@ -93601,19 +94101,11 @@ "type": "uuid" }, { - "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "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. 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": "an optional account for the VPN. Must be used with domainId.", @@ -93623,12 +94115,12 @@ "type": "string" }, { - "description": "an optional field, whether to the display the vpn to the end user or not", + "description": "an optional domainId for the VPN. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "fordisplay", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" } ], "related": "listRemoteAccessVpns", @@ -93639,20 +94131,19 @@ "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "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 id of the vpn", + "name": "projectid", + "type": "string" }, { "description": "the range of ips to allocate to the clients", @@ -93660,8 +94151,8 @@ "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicip", + "description": "the id of the remote access vpn", + "name": "id", "type": "string" }, { @@ -93669,47 +94160,48 @@ "name": "project", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ipsec preshared key", - "name": "presharedkey", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the public ip address of the vpn server", + "name": "publicip", "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": "is vpn for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ipsec preshared key", + "name": "presharedkey", + "type": "string" }, { - "description": "the domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the public ip address of the vpn server", + "name": "publicipid", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "the state of the rule", + "name": "state", "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" - } + }, + {} ] }, { @@ -93718,28 +94210,28 @@ "name": "changeServiceForVirtualMachine", "params": [ { - "description": "New maximum number of IOPS for the custom disk offering", + "description": "Verify OK to Shrink", "length": 255, - "name": "maxiops", + "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": "the service offering ID to apply to the virtual machine", + "description": "New maximum number of IOPS for the custom disk offering", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": true, - "type": "uuid" + "name": "maxiops", + "required": false, + "since": "4.17", + "type": "long" }, { "description": "New minimum number of IOPS for the custom disk offering", @@ -93750,12 +94242,20 @@ "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 virtual machine", "length": 255, - "name": "automigrate", - "required": false, - "since": "4.17", - "type": "boolean" + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + }, + { + "description": "the service offering ID to apply to the virtual machine", + "length": 255, + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", + "required": true, + "type": "uuid" }, { "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", @@ -93763,66 +94263,93 @@ "name": "details", "required": false, "type": "map" - }, - { - "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": true, - "type": "uuid" } ], - "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", + "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,createVMFromBackup,importVm", "response": [ { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "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": "the pool type of the virtual machine", - "name": "pooltype", - "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", + "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 read (IO) of disk on the VM", - "name": "diskioread", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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 domain in which the virtual machine exists", - "name": "domain", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "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", + "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", "type": "string" }, { @@ -93831,279 +94358,327 @@ "type": "string" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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": "tag key name", + "name": "key", "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": "customer associated with the tag", + "name": "customer", "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 key name", - "name": "key", + "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": "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 domain associated with the tag", + "name": "domain", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "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", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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": "the project id of the vm", - "name": "projectid", + "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "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 user's name who deployed the virtual machine", + "name": "username", + "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "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", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, + {}, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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 account owning the affinity group", + "name": "account", + "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 domain name of the affinity group", + "name": "domain", + "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" + }, + { + "description": "the ID of the affinity group", + "name": "id", + "type": "string" + }, + { + "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the name of the affinity group", + "name": "name", + "type": "string" + } + ], + "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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 date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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 name of the host for the virtual machine", + "name": "hostname", + "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "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 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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { "description": "list of security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "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 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", - "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", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { @@ -94111,19 +94686,24 @@ "name": "egressrule", "response": [ { - "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", + "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 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 code for the ICMP message response", @@ -94135,148 +94715,81 @@ "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": "id of the resource", + "name": "resourceid", "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": "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 key name", - "name": "key", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "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": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "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": "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 list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "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": "tag key name", - "name": "key", - "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": "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": "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 id of the security group rule", + "name": "ruleid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" } ], @@ -94293,8 +94806,13 @@ "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "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" }, { @@ -94302,8 +94820,18 @@ "name": "ingressrule", "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { @@ -94316,23 +94844,28 @@ "name": "account", "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": "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": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -94341,72 +94874,119 @@ "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 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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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 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 type of the ICMP message response", - "name": "icmptype", + "description": "the starting IP of the security group rule", + "name": "startport", "type": "integer" + } + ], + "type": "set" + }, + { + "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": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "the project id the tag belongs to", + "name": "projectid", "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "the account associated with the tag", + "name": "account", + "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 ID of the domain associated with the tag", + "name": "domainid", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" @@ -94417,27 +94997,22 @@ "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": "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", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { "description": "the ID of the host for the virtual machine", @@ -94445,18 +95020,8 @@ "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", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -94470,29 +95035,23 @@ "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "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", + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -94501,104 +95060,113 @@ "type": "boolean" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "NICs of the VNF appliance", - "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", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "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": "Guest vm Boot Type", - "name": "boottype", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "the state of the virtual machine", + "name": "state", "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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 virtual network for the service offering", - "name": "forvirtualnetwork", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "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": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "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" }, { @@ -94606,89 +95174,69 @@ "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "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": "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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 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", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the traffic type of the nic", + "name": "traffictype", "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": "MTU configured on the NIC", @@ -94696,23 +95244,33 @@ "type": "integer" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "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 vpc to which the nic belongs", - "name": "vpcid", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -94721,88 +95279,98 @@ "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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": "the traffic type of the nic", - "name": "traffictype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "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": "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" } ], "type": "set" }, {}, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "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": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "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": "publicip", + "type": "string" }, { "description": "the vGPU type used by the virtual machine", @@ -94810,126 +95378,50 @@ "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "OS type id of the vm", - "name": "ostypeid", + "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", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, + {}, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -94938,6 +95430,13 @@ "isasync": false, "name": "listGuestOsMapping", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "list mapping by Guest OS Type UUID", "length": 255, @@ -94946,6 +95445,13 @@ "required": false, "type": "uuid" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "list Guest OS mapping by hypervisor version. Must be used with hypervisor parameter", "length": 255, @@ -94954,16 +95460,17 @@ "type": "string" }, { - "description": "list Guest OS mapping by hypervisor", + "description": "list mapping by its UUID", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list Guest OS mapping by OS display name", + "description": "list Guest OS mapping by hypervisor", "length": 255, - "name": "osdisplayname", + "name": "hypervisor", "required": false, "type": "string" }, @@ -94975,19 +95482,11 @@ "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list mapping by its UUID", + "description": "list Guest OS mapping by OS display name", "length": 255, - "name": "id", - "related": "listGuestOsMapping,addGuestOsMapping,updateGuestOsMapping", + "name": "osdisplayname", "required": false, - "type": "uuid" + "type": "string" }, { "description": "List by keyword", @@ -94995,64 +95494,57 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "addGuestOsMapping,updateGuestOsMapping", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS mapping", + "name": "id", "type": "string" }, { - "description": "the ID of the Guest OS mapping", - "name": "id", + "description": "is the mapping user defined", + "name": "isuserdefined", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "version of the hypervisor for mapping", + "name": "hypervisorversion", "type": "string" }, - {}, { "description": "the ID of the Guest OS type", "name": "ostypeid", "type": "string" }, + {}, { "description": "standard display name for the Guest OS", "name": "osdisplayname", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "is the mapping user defined", - "name": "isuserdefined", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the hypervisor", - "name": "hypervisor", + "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.4.0" }, @@ -95062,82 +95554,82 @@ "name": "listTemplates", "params": [ { - "description": "list templates by zoneId", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "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": "", + "description": "the template name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "ID of the image or image cache store", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "since": "4.19", "type": "uuid" }, { - "description": "List by keyword", + "description": "list datadisk templates by parent template id", "length": 255, - "name": "keyword", + "name": "parenttemplateid", + "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": "string" + "since": "4.4", + "type": "uuid" }, { - "description": "If set to true, list only unique templates across zones", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "showunique", + "name": "forcks", "required": false, - "since": "4.13.2", + "since": "4.21.0", "type": "boolean" }, { "description": "the template ID", "length": 255, "name": "id", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "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 only resources belonging to the domain specified", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "isvnf", "required": false, - "type": "uuid" + "since": "4.19.0", + "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "show removed templates as well", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "showremoved", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "list templates by zoneId", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the hypervisor for which to restrict the search", @@ -95147,40 +95639,37 @@ "type": "string" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "ID of the extension for the template", "length": 255, - "name": "account", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the IDs of the templates, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "name": "ids", + "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": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "list templates that can be used to deploy CKS clusters", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "forcks", + "name": "tags", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "map" }, { - "description": "show removed templates as well", + "description": "the type of the template", "length": 255, - "name": "showremoved", + "name": "templatetype", "required": false, - "type": "boolean" + "since": "4.19.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.", @@ -95190,28 +95679,19 @@ "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "description": "", "length": 255, - "name": "arch", + "name": "pagesize", "required": false, - "since": "4.20", - "type": "string" + "type": "integer" }, { - "description": "the type of the template", + "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": "templatetype", - "required": false, - "since": "4.19.0", + "name": "templatefilter", + "required": true, "type": "string" }, - { - "description": "flag to display the resource image for the templates", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, { "description": "ID of the storage pool", "length": 255, @@ -95222,35 +95702,33 @@ "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "tags", + "name": "arch", "required": false, - "type": "map" + "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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "templatefilter", - "required": true, - "type": "string" + "name": "isrecursive", + "required": false, + "type": "boolean" }, { - "description": "list templates that are ready to be deployed", + "description": "", "length": 255, - "name": "isready", + "name": "page", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "the IDs of the templates, mutually exclusive with id", + "description": "flag to display the resource image for the templates", "length": 255, - "name": "ids", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,listTemplates,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "showicon", "required": false, - "since": "4.9", - "type": "list" + "type": "boolean" }, { "description": "the ID of the OS category for the template", @@ -95262,72 +95740,66 @@ "type": "uuid" }, { - "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "description": "ID of the image or image cache store", "length": 255, - "name": "details", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "since": "4.15", - "type": "list" + "since": "4.19", + "type": "uuid" }, { - "description": "list datadisk templates by parent template id", + "description": "list objects by project; if projectid=-1 lists All VMs", "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", + "name": "projectid", + "related": "createProject", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "ID of the extension for the template", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "name": "showunique", "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "since": "4.13.2", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 template name", - "name": "name", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" - }, - { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the template display text", - "name": "displaytext", - "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { @@ -95336,42 +95808,33 @@ "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": "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": "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": "true if the template is extractable, false otherwise", - "name": "isextractable", - "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": "the physical size of the template", + "name": "physicalsize", + "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" }, { @@ -95380,38 +95843,38 @@ "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": "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" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -95420,170 +95883,184 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the tag of this template", + "name": "templatetag", "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": "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": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "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 reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "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": "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": "the status of the template", + "name": "status", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, + {}, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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", - "name": "deployasisdetails", - "type": "map" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", - "name": "deployasis", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "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 template belongs", - "name": "domain", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "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": "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": "the date this template was created", - "name": "created", - "type": "date" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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", + "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": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { "description": "the account name to which the template belongs", @@ -95591,14 +96068,14 @@ "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 secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { "description": "the ID of the zone for this template", @@ -95606,24 +96083,34 @@ "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if template 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": "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": "the template name", + "name": "name", + "type": "string" }, { "description": "the date this template was removed", @@ -95631,18 +96118,23 @@ "type": "date" }, { - "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 project id of the template", - "name": "projectid", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "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", - "name": "domainpath", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" } ] @@ -95670,44 +96162,44 @@ ], "related": "listTungstenFabricPolicy", "response": [ - {}, + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "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 tag type uuid", "name": "uuid", "type": "string" }, - {}, - {}, { "description": "Tungsten-Fabric policy 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" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", + "type": "string" }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - } + {}, + {} ] }, { @@ -95725,27 +96217,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": "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" @@ -95756,11 +96248,19 @@ "name": "createBucket", "params": [ { - "description": "Enable object locking in bucket", + "description": "Id of the Object Storage Pool where bucket is created", "length": 255, - "name": "objectlocking", + "name": "objectstorageid", + "related": "addObjectStoragePool", + "required": true, + "type": "uuid" + }, + { + "description": "The Bucket access policy", + "length": 255, + "name": "policy", "required": false, - "type": "boolean" + "type": "string" }, { "description": "Bucket Quota in GiB", @@ -95769,13 +96269,6 @@ "required": true, "type": "integer" }, - { - "description": "Enable bucket encryption", - "length": 255, - "name": "encryption", - "required": false, - "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.", "length": 255, @@ -95793,69 +96286,48 @@ "type": "uuid" }, { - "description": "the name of the bucket", + "description": "Enable bucket versioning", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "versioning", + "required": false, + "type": "boolean" }, { - "description": "Id of the Object Storage Pool where bucket is created", + "description": "Enable bucket encryption", "length": 255, - "name": "objectstorageid", - "related": "addObjectStoragePool", - "required": true, - "type": "uuid" + "name": "encryption", + "required": false, + "type": "boolean" }, { - "description": "The Bucket access policy", + "description": "Enable object locking in bucket", "length": 255, - "name": "policy", + "name": "objectlocking", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the account associated with the bucket. Must be used with the domainId parameter.", + "description": "the name of the bucket", "length": 255, - "name": "account", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "Enable bucket versioning", + "description": "the account associated with the bucket. Must be used with the domainId parameter.", "length": 255, - "name": "versioning", + "name": "account", "required": false, - "type": "boolean" + "type": "string" } ], "related": "listBuckets", "response": [ - { - "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", - "type": "string" - }, { "description": "Bucket Object Locking", "name": "objectlocking", "type": "boolean" }, - { - "description": "the date the Bucket was created", - "name": "created", - "type": "date" - }, { "description": "the list of resource tags associated", "name": "tags", @@ -95866,18 +96338,13 @@ "type": "string" }, { - "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": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -95886,13 +96353,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -95901,26 +96368,42 @@ "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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 account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "Object storage provider", - "name": "provider", + "description": "the project name of the bucket", + "name": "project", + "type": "string" + }, + { + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" + }, + {}, + { + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "type": "string" }, { @@ -95929,36 +96412,40 @@ "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the account associated with the Bucket", + "name": "account", + "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "Bucket URL", - "name": "url", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Bucket Quota in GiB", - "name": "quota", - "type": "integer" + "description": "State of the Bucket", + "name": "state", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Object storage provider", + "name": "provider", + "type": "string" + }, + { + "description": "Bucket Quota in GiB", + "name": "quota", "type": "integer" }, - {}, { "description": "path of the domain to which the bucket belongs", "name": "domainpath", @@ -95966,18 +96453,13 @@ }, {}, { - "description": "Bucket Access Key", - "name": "accesskey", - "type": "string" - }, - { - "description": "the account associated with the Bucket", - "name": "account", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "the project id of the bucket", + "name": "projectid", "type": "string" }, { @@ -95986,38 +96468,48 @@ "type": "string" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" + "description": "the date the Bucket was created", + "name": "created", + "type": "date" }, { - "description": "ID of the Bucket", - "name": "id", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "the ID of the domain associated with the bucket", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "id of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstorageid", + "description": "name of the Bucket", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, + { + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" + }, { "description": "Bucket Secret Key", "name": "usersecretkey", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" } ], @@ -96029,32 +96521,23 @@ "name": "listPhysicalNetworks", "params": [ { - "description": "the Zone ID for the physical network", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "search by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "list physical network by id", - "length": 255, - "name": "id", - "related": "listPhysicalNetworks,updatePhysicalNetwork", - "required": false, - "type": "uuid" - }, - { - "description": "search by name", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, @@ -96066,34 +96549,47 @@ "type": "integer" }, { - "description": "", + "description": "list physical network by id", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listPhysicalNetworks,updatePhysicalNetwork", "required": false, - "type": "integer" + "type": "uuid" + }, + { + "description": "the Zone ID for the physical network", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "updatePhysicalNetwork", "response": [ - {}, { - "description": "zone id of the physical network", - "name": "zoneid", + "description": "name of the physical network", + "name": "name", "type": "string" }, { - "description": "the domain id of the physical network owner", - "name": "domainid", + "description": "state of the physical network", + "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 physical network", + "name": "id", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" + }, + { + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { @@ -96102,13 +96598,13 @@ "type": "string" }, { - "description": "the uuid of the physical network", - "name": "id", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "comma separated tag", - "name": "tags", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { @@ -96116,31 +96612,27 @@ "name": "isolationmethods", "type": "string" }, - { - "description": "name of the physical network", - "name": "name", - "type": "string" - }, {}, { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "zone name of the physical network", - "name": "zonename", + "description": "comma separated tag", + "name": "tags", "type": "string" }, { - "description": "state of the physical network", - "name": "state", + "description": "zone id of the physical network", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "3.0.0" @@ -96151,109 +96643,110 @@ "name": "listFirewallRules", "params": [ { - "description": "the ID of IP address of the firewall services", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "list firewall rules for certain network", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "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": "List resources by tags (key/value pairs)", + "description": "", "length": 255, - "name": "tags", + "name": "page", "required": false, - "type": "map" + "type": "integer" }, { - "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": "list firewall rules for certain network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "uuid" + "type": "integer" }, { - "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": "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": "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", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "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": "Lists rule with the specified ID.", "length": 255, - "name": "isrecursive", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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": "createProject", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.4", + "type": "boolean" }, { - "description": "", + "description": "the ID of IP address of the firewall services", "length": 255, - "name": "page", + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Lists rule with the specified 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": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" } ], "related": "createFirewallRule,updateEgressFirewallRule", "response": [ + {}, { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -96261,10 +96754,9 @@ "name": "cidrlist", "type": "string" }, - {}, { - "description": "the protocol of the firewall rule", - "name": "protocol", + "description": "the public ip address for the firewall rule", + "name": "ipaddress", "type": "string" }, { @@ -96272,59 +96764,58 @@ "name": "fordisplay", "type": "boolean" }, - {}, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "the ending port of firewall rule's port range", + "name": "endport", + "type": "integer" }, { "description": "the list of resource tags associated with the rule", "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": "tag value", + "name": "value", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "resource type", + "name": "resourcetype", "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": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -96333,67 +96824,68 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "list" }, { - "description": "the network id of the firewall rule", - "name": "networkid", - "type": "string" - }, - { - "description": "the ID of the firewall rule", - "name": "id", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "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", + "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": "type of the icmp message being sent", "name": "icmptype", "type": "integer" }, + { + "description": "the ID of the firewall rule", + "name": "id", + "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 (,).", - "name": "destcidrlist", + "description": "the public ip address id for the firewall rule", + "name": "ipaddressid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the starting port of firewall rule's port range", + "name": "startport", + "type": "integer" + }, + { + "description": "the state of the rule", + "name": "state", "type": "string" }, { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", + "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", - "type": "integer" + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" } ] }, @@ -96412,16 +96904,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", - "type": "integer" - }, {}, {}, { @@ -96429,394 +96911,404 @@ "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": "Lists all Routing firewall rules", - "isasync": false, - "name": "listRoutingFirewallRules", + "description": "Extracts an ISO", + "isasync": true, + "name": "extractIso", "params": [ { - "description": "List resources by tags (key/value pairs)", - "length": 255, - "name": "tags", - "required": false, - "type": "map" - }, - { - "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": "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" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", + "description": "the URL to which the ISO would be extracted", + "length": 2048, + "name": "url", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists Routing firewall rule with the specified ID", + "description": "the ID of the ISO file", "length": 255, "name": "id", - "related": "listRoutingFirewallRules,createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "required": false, + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "required": true, "type": "uuid" - }, + } + ], + "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "response": [ { - "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": "zone name the object was extracted from", + "name": "zonename", + "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 status of the extraction", + "name": "status", + "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 time and date the object was created", + "name": "created", + "type": "date" }, { - "description": "list Routing firewall rules by network ID", - "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, - "type": "uuid" + "description": "the upload id of extracted object", + "name": "extractId", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" + "description": "the mode of extraction - upload or download", + "name": "extractMode", + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "type of the storage", + "name": "storagetype", "type": "string" - } - ], - "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", - "response": [ + }, { - "description": "the state of the rule", - "name": "state", + "description": "zone ID the object was extracted from", + "name": "zoneid", "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 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": "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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", + "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", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "description": "the id of extracted object", + "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 percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, + {}, + {}, { - "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 starting port of port forwarding rule's private port range", - "name": "privateport", + "description": "the name of the extracted object", + "name": "name", "type": "string" - }, + } + ] + }, + { + "description": "Lists all Routing firewall rules", + "isasync": false, + "name": "listRoutingFirewallRules", + "params": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "list Routing firewall rules by traffic type - ingress or egress", + "length": 255, + "name": "traffictype", + "required": false, "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", - "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 VM name for the port forwarding rule", - "name": "virtualmachinename", - "type": "string" + "description": "list Routing firewall rules by network ID", + "length": 255, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" }, { - "description": "the public ip address id for the port forwarding rule", - "name": "ipaddressid", - "type": "string" + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, "type": "integer" }, { - "description": "the protocol of the port forwarding rule", - "name": "protocol", - "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 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": "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 id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "type": "string" - } - ], - "since": "4.20.0" - }, - { - "description": "Extracts an ISO", - "isasync": true, - "name": "extractIso", - "params": [ - { - "description": "the URL to which the ISO would be extracted", - "length": 2048, - "name": "url", + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the ISO file", + "description": "List by keyword", "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": true, - "type": "uuid" + "name": "keyword", + "required": false, + "type": "string" }, { - "description": "the ID of the zone where the ISO is originally located", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "Lists Routing firewall rule with the specified ID", "length": 255, - "name": "mode", - "required": true, - "type": "string" + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule,listRoutingFirewallRules", + "required": false, + "type": "uuid" } ], - "related": "extractSnapshot,extractTemplate,downloadImageStoreObject", + "related": "createPortForwardingRule,updatePortForwardingRule,createIpForwardingRule", "response": [ + { + "description": "the ending port of port forwarding rule's private port range", + "name": "privateendport", + "type": "string" + }, + { + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", + "type": "string" + }, + { + "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": "zone name the object was extracted from", - "name": "zonename", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the public ip address id for the port forwarding rule", + "name": "ipaddressid", "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 cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "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": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, - {}, - {}, { - "description": "the status of the extraction", - "name": "status", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the state of the rule", + "name": "state", + "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "description": "the VM display name for the port forwarding rule", + "name": "virtualmachinedisplayname", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", - "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": "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": "tag key name", + "name": "key", + "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": "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": "list" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, + {}, { - "description": "the state of the extracted object", - "name": "state", + "description": "the ending port of port forwarding rule's private port range", + "name": "publicendport", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", - "type": "integer" + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" }, { - "description": "", - "name": "resultstring", - "type": "string" + "description": "is firewall for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the VM name for the port forwarding rule", + "name": "virtualmachinename", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Creates an affinity/anti-affinity group", @@ -96830,6 +97322,14 @@ "required": false, "type": "string" }, + { + "description": "create affinity group for project", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, { "description": "name of the affinity group", "length": 255, @@ -96837,6 +97337,13 @@ "required": true, "type": "string" }, + { + "description": "an account for the affinity group. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "domainId of the account owning the affinity group", "length": 255, @@ -96851,50 +97358,34 @@ "name": "type", "required": true, "type": "string" - }, - { - "description": "create affinity group for project", - "length": 255, - "name": "projectid", - "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 description of the affinity group", - "name": "description", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the affinity group", - "name": "id", - "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", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { @@ -96902,44 +97393,45 @@ "name": "virtualmachineIds", "type": "list" }, + {}, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "path of the Domain the affinity 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 type of the affinity group", + "name": "type", + "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account owning the affinity group", + "name": "account", "type": "string" } ] @@ -96949,6 +97441,13 @@ "isasync": false, "name": "oauthlogin", "params": [ + { + "description": "Name of the provider", + "length": 255, + "name": "provider", + "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.", "length": 255, @@ -96957,16 +97456,16 @@ "type": "long" }, { - "description": "Email id with which user tried to login using OAuth provider", + "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", "length": 255, - "name": "email", - "required": true, + "name": "secretcode", + "required": false, "type": "string" }, { - "description": "Name of the provider", + "description": "Email id with which user tried to login using OAuth provider", "length": 255, - "name": "provider", + "name": "email", "required": true, "type": "string" }, @@ -96976,30 +97475,24 @@ "name": "domain", "required": false, "type": "string" - }, - { - "description": "Code that is provided by OAuth provider (Eg. google, github) after successful login", - "length": 255, - "name": "secretcode", - "required": false, - "type": "string" } ], - "related": "", + "related": "samlSso", "response": [ { - "description": "the time period before the session has expired", - "name": "timeout", - "type": "integer" + "description": "Is two factor authentication enabled", + "name": "is2faenabled", + "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": "Username", - "name": "username", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { @@ -97008,45 +97501,48 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "first name of the user", + "name": "firstname", + "type": "string" + }, + { + "description": "the time period before the session has expired", + "name": "timeout", "type": "integer" }, { - "description": "Two factor authentication issuer", - "name": "issuerfor2fa", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "Is two factor authentication enabled", - "name": "is2faenabled", + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, - {}, { - "description": "Two factor authentication provider", - "name": "providerfor2fa", + "description": "Is user registered", + "name": "registered", "type": "string" }, - {}, { "description": "the account name the user belongs to", "name": "account", "type": "string" }, { - "description": "Is two factor authentication verified", - "name": "is2faverified", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "Domain ID that the user belongs to", - "name": "domainid", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "Management Server ID that the user logged to", - "name": "managementserverid", + "description": "user time zone", + "name": "timezone", "type": "string" }, { @@ -97055,34 +97551,30 @@ "type": "string" }, { - "description": "the account type (admin, domain-admin, read-only-admin, user)", - "name": "type", - "type": "string" - }, - { - "description": "first name of the user", - "name": "firstname", + "description": "Username", + "name": "username", "type": "string" }, { - "description": "user time zone", - "name": "timezone", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, + {}, { - "description": "Session key that can be passed in subsequent Query command calls", - "name": "sessionkey", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "Is user registered", - "name": "registered", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "last name of the user", - "name": "lastname", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.19.0" @@ -97093,11 +97585,12 @@ "name": "listInternalLoadBalancerElements", "params": [ { - "description": "list internal load balancer elements by enabled state", + "description": "list internal load balancer elements by network service provider id", "length": 255, - "name": "enabled", + "name": "nspid", + "related": "addNetworkServiceProvider,listTrafficTypes", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "List by keyword", @@ -97115,34 +97608,38 @@ "type": "uuid" }, { - "description": "", + "description": "list internal load balancer elements by enabled state", "length": 255, - "name": "pagesize", + "name": "enabled", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "list internal load balancer elements by network service provider id", + "description": "", "length": 255, - "name": "nspid", - "related": "addNetworkServiceProvider,listTrafficTypes", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "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" }, {}, { @@ -97152,18 +97649,13 @@ }, {}, { - "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": "Enabled/Disabled the element", + "name": "enabled", + "type": "boolean" }, { - "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" } ], @@ -97208,40 +97700,40 @@ "name": "jobid", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the guest OS list of the hypervisor", "name": "guestoslist", "response": [ { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" } ], "type": "list" }, {}, - { - "description": "the guest OS count of the hypervisor", - "name": "guestoscount", - "type": "integer" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + {}, { "description": "the hypervisor", "name": "hypervisor", "type": "string" }, - {} + { + "description": "the guest OS count of the hypervisor", + "name": "guestoscount", + "type": "integer" + } ], "since": "4.19.0" }, @@ -97251,33 +97743,26 @@ "name": "createTungstenFabricProvider", "params": [ { - "description": "Tungsten-Fabric provider gateway", + "description": "Tungsten-Fabric provider vrouter port", "length": 255, - "name": "tungstengateway", - "required": true, + "name": "tungstenprovidervrouterport", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric provider name", + "description": "Tungsten-Fabric provider hostname", "length": 255, - "name": "name", + "name": "tungstenproviderhostname", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider port", + "description": "Tungsten-Fabric provider introspect port", "length": 255, - "name": "tungstenproviderport", + "name": "tungstenproviderintrospectport", "required": false, "type": "string" }, - { - "description": "Tungsten-Fabric provider hostname", - "length": 255, - "name": "tungstenproviderhostname", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -97287,16 +97772,23 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric provider introspect port", + "description": "Tungsten-Fabric provider gateway", "length": 255, - "name": "tungstenproviderintrospectport", - "required": false, + "name": "tungstengateway", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric provider vrouter port", + "description": "Tungsten-Fabric provider name", "length": 255, - "name": "tungstenprovidervrouterport", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric provider port", + "length": 255, + "name": "tungstenproviderport", "required": false, "type": "string" } @@ -97304,45 +97796,45 @@ "related": "", "response": [ { - "description": "Tungsten-Fabric provider uuid", - "name": "tungstenprovideruuid", + "description": "Tungsten-Fabric provider hostname", + "name": "tungstenproviderhostname", "type": "string" }, + {}, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", - "type": "boolean" + "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Tungsten-Fabric provider uuid", + "name": "tungstenprovideruuid", + "type": "string" }, { "description": "Tungsten-Fabric provider vrouter port", "name": "tungstenprovidervrouterport", "type": "string" }, + {}, { - "description": "Tungsten-Fabric provider gateway", - "name": "tungstengateway", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Tungsten-Fabric provider port", - "name": "tungstenproviderport", + "description": "Tungsten-Fabric provider name", + "name": "name", "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" }, { @@ -97351,18 +97843,18 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider name", - "name": "name", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "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 port", + "name": "tungstenproviderport", "type": "string" } ] @@ -97372,6 +97864,14 @@ "isasync": true, "name": "rebootVirtualMachine", "params": [ + { + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + }, { "description": "Force reboot the VM (VM is Stopped and then Started)", "length": 255, @@ -97387,46 +97887,99 @@ "required": false, "since": "4.15.0.0", "type": "boolean" - }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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": "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", + "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,createVMFromBackup,importVm", "response": [ { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the state of the virtual machine", - "name": "state", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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 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", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "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 VM's disk read in KiB", + "name": "diskkbsread", + "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", + "type": "integer" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { @@ -97435,18 +97988,105 @@ "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "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 ID of the affinity group", + "name": "id", + "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": "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": "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 project ID of the affinity group", + "name": "projectid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { @@ -97455,18 +98095,180 @@ "type": "string" }, { - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "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": "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": "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 domain associated with the tag", + "name": "domain", + "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": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "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": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "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", + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" + }, + { + "description": "the user's name who deployed the virtual machine", + "name": "username", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "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 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", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -97474,23 +98276,113 @@ "name": "guestosid", "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "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 Type", + "name": "boottype", + "type": "string" + }, + { + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "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 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": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the type of the nic", + "name": "type", "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", + "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" }, { @@ -97504,78 +98396,63 @@ "type": "boolean" }, { - "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", + "description": "the name of the corresponding network", + "name": "networkname", "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": "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 type of the nic", - "name": "type", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "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": "Type of adapter if available", - "name": "adaptertype", + "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 IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -97584,28 +98461,28 @@ "type": "list" }, { - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "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": "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 gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -97614,224 +98491,147 @@ "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the ID of the nic", + "name": "id", "type": "string" + }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "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 VM's primary IP address", - "name": "ipaddress", - "type": "string" + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, - {}, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 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 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 name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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", + "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": "User VM type", - "name": "vmtype", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { @@ -97840,221 +98640,170 @@ "type": "boolean" }, { - "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": "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", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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": "the pool type of the virtual machine", - "name": "pooltype", + "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": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "the name of the virtual machine", - "name": "name", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "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": "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 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 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 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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "id of the resource", + "name": "resourceid", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, - { - "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "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", - "name": "protocol", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "security group name", @@ -98062,8 +98811,8 @@ "type": "string" }, { - "description": "account owning the security group rule", - "name": "account", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -98071,76 +98820,14 @@ "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": "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": "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 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" - } - ], - "type": "set" - }, { "description": "the ending IP of the security group rule ", "name": "endport", "type": "integer" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -98149,28 +98836,13 @@ "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" } ], "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", @@ -98181,33 +98853,33 @@ "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": "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": "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": "the project name where tag belongs to", + "name": "project", "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" }, { @@ -98216,36 +98888,26 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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 project id the tag belongs to", - "name": "projectid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "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", + "description": "the description of the security group", + "name": "description", "type": "string" }, { @@ -98254,8 +98916,8 @@ "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { @@ -98264,296 +98926,126 @@ "type": "set" }, { - "description": "the description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the account owning the security group", - "name": "account", - "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 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": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "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 description of the affinity group", - "name": "description", - "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": "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": "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 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": "the domain ID of the affinity group", - "name": "domainid", - "type": "string" - } - ], - "type": "set" - }, - { - "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 userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - {}, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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": "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", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 domain in which the virtual machine exists", - "name": "domainid", - "type": "string" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "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 maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "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", - "type": "string" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "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": "OS type id of the vm", - "name": "ostypeid", - "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 count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "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 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": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "account owning the security group rule", + "name": "account", + "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": "the ending IP of the security group rule ", + "name": "endport", + "type": "integer" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + } + ], + "type": "set" } ] }, @@ -98572,28 +99064,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": "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.11" }, @@ -98602,13 +99094,6 @@ "isasync": false, "name": "addVirtualMachinesToKubernetesCluster", "params": [ - { - "description": "Is control node or not? Defaults to false.", - "length": 255, - "name": "iscontrolnode", - "required": false, - "type": "boolean" - }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -98621,34 +99106,41 @@ "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", + "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,createVMFromBackup,importVm", "required": true, "type": "list" + }, + { + "description": "Is control node or not? Defaults to false.", + "length": 255, + "name": "iscontrolnode", + "required": false, + "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": "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" - } + {} ], "since": "4.19.0" }, @@ -98657,13 +99149,6 @@ "isasync": false, "name": "listTungstenFabricLogicalRouter", "params": [ - { - "description": "the uuid of Tungsten-Fabric logical router", - "length": 255, - "name": "logicalrouteruuid", - "required": false, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -98686,6 +99171,13 @@ "required": false, "type": "integer" }, + { + "description": "the uuid of Tungsten-Fabric logical router", + "length": 255, + "name": "logicalrouteruuid", + "required": false, + "type": "string" + }, { "description": "the uuid of Tungsten-Fabric network", "length": 255, @@ -98708,37 +99200,37 @@ "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" + }, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - {}, - {}, { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" + "description": "Tungsten-Fabric logical router 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", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric logical router uuid", - "name": "uuid", - "type": "string" } ] }, @@ -98748,41 +99240,41 @@ "name": "listBackupOfferings", "params": [ { - "description": "", + "description": "The zone ID", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "The backup offering ID", + "description": "", "length": 255, - "name": "id", - "related": "listBackupOfferings,updateBackupOffering", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The zone ID", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "The backup offering ID", "length": 255, - "name": "keyword", + "name": "id", + "related": "listBackupOfferings,updateBackupOffering", "required": false, - "type": "string" + "type": "uuid" } ], "related": "updateBackupOffering", @@ -98792,23 +99284,36 @@ "name": "allowuserdrivenbackups", "type": "boolean" }, - {}, + { + "description": "provider name", + "name": "provider", + "type": "string" + }, { "description": "zone name", "name": "zonename", "type": "string" }, + { + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the date this backup offering was created", "name": "created", "type": "date" }, { - "description": "provider name", - "name": "provider", + "description": "zone ID", + "name": "zoneid", "type": "string" }, - {}, { "description": "external ID on the provider side", "name": "externalid", @@ -98819,29 +99324,21 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name for the backup offering", + "name": "name", "type": "string" } ], @@ -98853,54 +99350,61 @@ "name": "listGpuCards", "params": [ { - "description": "device ID of the GPU card", + "description": "vendor name of the GPU card", "length": 255, - "name": "deviceid", + "name": "vendorname", "required": false, "type": "string" }, { - "description": "device name of the GPU card", + "description": "List by keyword", "length": 255, - "name": "devicename", + "name": "keyword", "required": false, "type": "string" }, { - "description": "vendor ID of the GPU card", + "description": "", "length": 255, - "name": "vendorid", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "device ID of the GPU card", + "length": 255, + "name": "deviceid", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "ID of the GPU card", + "description": "vendor ID of the GPU card", "length": 255, - "name": "id", - "related": "listGpuCards", + "name": "vendorid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "vendor name of the GPU card", + "description": "device name of the GPU card", "length": 255, - "name": "vendorname", + "name": "devicename", "required": false, "type": "string" }, { - "description": "List by keyword", + "description": "ID of the GPU card", "length": 255, - "name": "keyword", + "name": "id", + "related": "listGpuCards", "required": false, - "type": "string" + "type": "uuid" }, { "description": "If true, only GPU cards which have a device will be listed. If false, all GPU cards will be listed.", @@ -98908,25 +99412,24 @@ "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", + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "the vendor name of the GPU card", - "name": "vendorname", + "description": "the device name of the GPU card", + "name": "devicename", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", "type": "string" }, { @@ -98939,26 +99442,20 @@ "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", + "description": "the ID of the GPU card", + "name": "id", "type": "string" }, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the device ID of the GPU card", + "name": "deviceid", "type": "string" } ], @@ -98969,20 +99466,6 @@ "isasync": true, "name": "addGuestOsMapping", "params": [ - { - "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", - "length": 255, - "name": "osdisplayname", - "required": false, - "type": "string" - }, - { - "description": "OS name specific to the hypervisor", - "length": 255, - "name": "osnameforhypervisor", - "required": true, - "type": "string" - }, { "description": "UUID of Guest OS type. Either the UUID or Display Name must be passed", "length": 255, @@ -98992,68 +99475,80 @@ "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": "Forces add user defined guest os mapping, overrides any existing user defined mapping", "length": 255, - "name": "osmappingcheckenabled", + "name": "forced", "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", + "description": "OS name specific to the hypervisor", "length": 255, - "name": "hypervisorversion", + "name": "osnameforhypervisor", "required": true, "type": "string" }, { - "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "description": "Display Name of Guest OS standard type. Either Display Name or UUID must be passed", "length": 255, - "name": "hypervisor", + "name": "osdisplayname", + "required": false, + "type": "string" + }, + { + "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" }, { - "description": "Forces add user defined guest os mapping, overrides any existing user defined mapping", + "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": "forced", + "name": "osmappingcheckenabled", "required": false, "since": "4.19.0", "type": "boolean" + }, + { + "description": "Hypervisor type. One of : XenServer, KVM, VMWare", + "length": 255, + "name": "hypervisor", + "required": true, + "type": "string" } ], "related": "updateGuestOsMapping", "response": [ - {}, + { + "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": "is the mapping user defined", - "name": "isuserdefined", - "type": "string" - }, - { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, - {}, { "description": "the ID of the Guest OS mapping", "name": "id", "type": "string" }, { - "description": "version of the hypervisor for mapping", - "name": "hypervisorversion", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "standard display name for the Guest OS", + "name": "osdisplayname", "type": "string" }, { @@ -99061,14 +99556,16 @@ "name": "hypervisor", "type": "string" }, + {}, + {}, { - "description": "standard display name for the Guest OS", - "name": "osdisplayname", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "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" } ], @@ -99079,44 +99576,31 @@ "isasync": false, "name": "listVnfTemplates", "params": [ - { - "description": "the hypervisor for which to restrict the search", - "length": 255, - "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, - "since": "4.15", - "type": "list" - }, { "description": "list datadisk templates by parent template id", "length": 255, "name": "parenttemplateid", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "since": "4.4", "type": "uuid" }, { - "description": "list templates that can be used to deploy CKS clusters", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "forcks", + "name": "arch", "required": false, - "since": "4.21.0", - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "List resources by tags (key/value pairs)", + "description": "ID of the extension for the template", "length": 255, - "name": "tags", + "name": "extensionid", + "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", "required": false, - "type": "map" + "since": "4.21.0", + "type": "uuid" }, { "description": "", @@ -99126,120 +99610,106 @@ "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 templates by zoneId", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", "length": 255, - "name": "pagesize", + "name": "isvnf", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "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,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "the template name", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "List by keyword", + "description": "list templates that are ready to be deployed", "length": 255, - "name": "keyword", + "name": "isready", "required": false, - "type": "string" + "since": "4.21.0", + "type": "boolean" }, { - "description": "flag to list VNF templates or not; true if need to list VNF templates, false otherwise.", + "description": "the ID of the OS category for the template", "length": 255, - "name": "isvnf", + "name": "oscategoryid", + "related": "listOsCategories", "required": false, - "since": "4.19.0", - "type": "boolean" + "since": "4.21.0", + "type": "uuid" }, { - "description": "flag to display the resource image for the templates", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "showicon", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "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,listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { "description": "the IDs of the templates, mutually exclusive with id", "length": 255, "name": "ids", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "since": "4.9", "type": "list" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "listall", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "ID of the extension for the template", + "description": "the type of the template", "length": 255, - "name": "extensionid", - "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", + "name": "templatetype", "required": false, - "since": "4.21.0", - "type": "uuid" + "since": "4.19.0", + "type": "string" }, { - "description": "show removed templates as well", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "showremoved", + "name": "hypervisor", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the OS category for the template", + "description": "list templates that can be used to deploy CKS clusters", "length": 255, - "name": "oscategoryid", - "related": "listOsCategories", + "name": "forcks", "required": false, "since": "4.21.0", - "type": "uuid" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "If set to true, list only unique templates across zones", + "description": "List by keyword", "length": 255, - "name": "showunique", + "name": "keyword", "required": false, - "since": "4.13.2", - "type": "boolean" + "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).", @@ -99249,193 +99719,98 @@ "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "show removed templates as well", "length": 255, - "name": "account", + "name": "showremoved", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list templates that are ready to be deployed", + "description": "", "length": 255, - "name": "isready", + "name": "pagesize", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "the type of the template", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "templatetype", + "name": "isrecursive", "required": false, - "since": "4.19.0", - "type": "string" + "type": "boolean" }, { "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", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "description": "list templates by zoneId", + "description": "If set to true, list only unique templates across zones", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "showunique", "required": false, - "type": "uuid" - } - ], - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" - }, - { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "since": "4.13.2", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" }, - {}, { "description": "the template name", + "length": 255, "name": "name", + "required": false, "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "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": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "flag to display the resource image for the templates", + "length": 255, + "name": "showicon", + "required": false, "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": "additional key/value details tied with template", + "description": "comma separated list of template details requested, value can be a list of [ all, min]", + "length": 255, "name": "details", - "type": "map" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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 date this template was created", - "name": "created", - "type": "date" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", + "required": false, + "since": "4.15", "type": "list" - }, + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" - }, - { - "description": "the template display text", - "name": "displaytext", - "type": "string" - }, { "description": "the userdata override policy with the userdata provided while deploying VM", "name": "userdatapolicy", "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "the list of resource tags associated", @@ -99447,18 +99822,18 @@ "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": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -99467,13 +99842,13 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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" }, { @@ -99482,57 +99857,62 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "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": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "The name of extension linked to this template", + "name": "extensionname", + "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 template name", + "name": "name", "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 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": "the account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { "description": "the name of the domain to which the template belongs", @@ -99540,49 +99920,86 @@ "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "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": "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": "the ID of the OS type for this template.", + "name": "ostypeid", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, + {}, { "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 created", + "name": "created", + "type": "date" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the size of the template", "name": "size", "type": "long" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "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 physical size of the template", + "name": "physicalsize", + "type": "long" }, { "description": "the account name to which the template belongs", @@ -99590,9 +100007,24 @@ "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 template ID", + "name": "id", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -99600,49 +100032,114 @@ "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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 userdata linked to this template", + "name": "userdataname", + "type": "string" + }, + { + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" + }, { "description": "the template ID of the parent template if present", "name": "sourcetemplateid", "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 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": "the name of the zone for this template", + "name": "zonename", + "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 template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "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", + "description": "the account id to which the template belongs", + "name": "accountid", + "type": "string" + }, + { + "description": "CPU Arch of the template", + "name": "arch", + "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the type of the template", + "name": "templatetype", "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 template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" } ], @@ -99654,40 +100151,87 @@ "name": "deployVnfAppliance", "params": [ { - "description": "comma separated list of affinity groups id that are going to be applied to the virtual machine. Mutually exclusive with affinitygroupnames parameter", + "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "list" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "description": "the ID of the disk offering for the virtual machine. If the template is of ISO format, the diskOfferingId is for the root disk volume. Otherwise this parameter is used to indicate the offering for the data disk volume. If the templateId parameter passed is from a Template object, the diskOfferingId refers to a DATA Disk Volume created. If the templateId parameter passed is from an ISO object, the diskOfferingId refers to a ROOT Disk Volume created.", "length": 255, - "name": "size", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "type": "uuid" }, { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "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": "bootintosetup", + "name": "bootmode", + "required": false, + "since": "4.14.0.0", + "type": "string" + }, + { + "description": "name of the ssh key pair used to login to the virtual machine", + "length": 255, + "name": "keypair", + "required": false, + "type": "string" + }, + { + "description": "Lease expiry action, valid values are STOP and DESTROY", + "length": 255, + "name": "leaseexpiryaction", + "required": false, + "since": "4.21.0", + "type": "string" + }, + { + "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": "iothreadsenabled", "required": false, - "since": "4.15.0.0", "type": "boolean" }, { - "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": "", "length": 255, - "name": "nicnetworklist", + "name": "snapshotid", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "required": false, + "since": "4.21", + "type": "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": "rootdisksize", + "required": false, + "since": "4.4", + "type": "long" + }, + { + "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": "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, - "since": "4.15", "type": "map" }, { - "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": "the ipv6 address for default vm's network", "length": 255, - "name": "keyboard", + "name": "ip6address", "required": false, "type": "string" }, @@ -99700,21 +100244,11 @@ "type": "map" }, { - "description": "The number of queues for multiqueue NICs.", - "length": 255, - "name": "nicmultiqueuenumber", - "required": false, - "since": "4.18", - "type": "integer" - }, - { - "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" }, { "description": "the ID of the service offering for the virtual machine", @@ -99725,96 +100259,58 @@ "type": "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", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "datadisksdetails", + "name": "size", "required": false, - "since": "4.21.0", - "type": "map" + "type": "long" }, { - "description": "comma separated list of affinity groups names that are going to be applied to the virtual machine.Mutually exclusive with affinitygroupids parameter", + "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": "affinitygroupnames", - "related": "", + "name": "securitygroupnames", + "related": "updateSecurityGroup", "required": false, "type": "list" }, - { - "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": "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": "the ID of the template for the virtual machine", "length": 255, "name": "templateid", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "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": "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": "The number of queues for multiqueue NICs.", "length": 255, - "name": "securitygroupids", - "related": "updateSecurityGroup", + "name": "nicmultiqueuenumber", "required": false, - "type": "list" + "since": "4.18", + "type": "integer" }, { - "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": "used to specify the parameters values for the variables in userdata.", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "userdatadetails", "required": false, + "since": "4.18", "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": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "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": "the ID of the Userdata", "length": 255, - "name": "securitygroupnames", - "related": "updateSecurityGroup", + "name": "userdataid", + "related": "listCniConfiguration", "required": false, - "type": "list" + "since": "4.18", + "type": "uuid" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "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": "deploymentplanner", + "name": "keyboard", "required": false, - "since": "4.4", "type": "string" }, { @@ -99825,9 +100321,9 @@ "type": "string" }, { - "description": "the ip address for default vm's network", + "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": "ipaddress", + "name": "hypervisor", "required": false, "type": "string" }, @@ -99838,6 +100334,14 @@ "required": false, "type": "string" }, + { + "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": "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, @@ -99846,20 +100350,12 @@ "type": "string" }, { - "description": "Deploy vm for the project", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" - }, - { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "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": "leaseexpiryaction", + "name": "datadisksdetails", "required": false, "since": "4.21.0", - "type": "string" + "type": "map" }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", @@ -99870,41 +100366,36 @@ "type": "map" }, { - "description": "an optional user generated name for the virtual machine", + "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": "displayname", + "name": "boottype", "required": false, + "since": "4.14.0.0", "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "keypair", + "name": "details", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { - "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": "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": "diskofferingid", - "related": "", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", - "length": 255, - "name": "startvm", - "required": false, - "type": "boolean" - }, - { - "description": "names of the ssh key pairs used to login to the virtual machine", + "description": "used to specify the vApp properties.", "length": 255, - "name": "keypairs", + "name": "properties", "required": false, - "since": "4.17", - "type": "list" + "since": "4.15", + "type": "map" }, { "description": "Enable packed virtqueues or not.", @@ -99915,66 +100406,79 @@ "type": "boolean" }, { - "description": "used to specify the vApp properties.", + "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 user generated name for the virtual machine", "length": 255, - "name": "properties", + "name": "displayname", "required": false, - "since": "4.15", - "type": "map" + "type": "string" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", "length": 255, - "name": "copyimagetags", + "name": "bootintosetup", "required": false, - "since": "4.13", + "since": "4.15.0.0", "type": "boolean" }, { - "description": "", + "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": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "iptonetworklist", "required": false, - "since": "4.21", - "type": "uuid" + "type": "map" }, { - "description": "Controls specific policies on IO", + "description": "the mac address for default vm's network", "length": 255, - "name": "iodriverpolicy", + "name": "macaddress", "required": false, "type": "string" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "affinitygroupnames", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "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": "an optional group for the virtual machine", "length": 255, - "name": "hypervisor", + "name": "group", "required": false, "type": "string" }, { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "description": "host name for the virtual machine", "length": 255, - "name": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "host name for the virtual machine", + "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": "name", + "name": "overridediskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.17", + "type": "uuid" + }, + { + "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, + "name": "vnfconfiguremanagement", + "required": false, + "type": "boolean" }, { "description": "Number of days instance is leased for.", @@ -99985,65 +100489,73 @@ "type": "integer" }, { - "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": "Controls specific policies on IO", "length": 255, - "name": "iothreadsenabled", + "name": "iodriverpolicy", "required": false, - "type": "boolean" + "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": "availability zone for the virtual machine", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "the mac address for default vm's network", + "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": "macaddress", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "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.", + "description": "the ip address for default vm's network", "length": 255, - "name": "vnfconfiguremanagement", + "name": "ipaddress", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "userdatadetails", + "name": "copyimagetags", "required": false, - "since": "4.18", - "type": "map" + "since": "4.13", + "type": "boolean" }, { - "description": "availability zone for the virtual machine", + "description": "Deploy vm for the project", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "projectid", + "related": "createProject", + "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "description": "true if virtual machine needs to be dynamically scalable", "length": 255, - "name": "displayvm", + "name": "dynamicscalingenabled", "required": false, - "since": "4.2", + "since": "4.16", "type": "boolean" }, { - "description": "", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", "length": 255, - "name": "snapshotid", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "deploymentplanner", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.21", "type": "uuid" }, { @@ -100055,28 +100567,29 @@ "type": "string" }, { - "description": "the ID of the Userdata", + "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": "userdataid", - "related": "listCniConfiguration", + "name": "securitygroupids", + "related": "updateSecurityGroup", "required": false, - "since": "4.18", - "type": "uuid" + "type": "list" }, { - "description": "the ipv6 address for default vm's network", + "description": "", "length": 255, - "name": "ip6address", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "string" + "since": "4.21", + "type": "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", + "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": "rootdisksize", + "name": "nicnetworklist", "required": false, - "since": "4.4", - "type": "long" + "since": "4.15", + "type": "map" }, { "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.", @@ -100084,314 +100597,255 @@ "name": "vnfcidrlist", "required": false, "type": "list" + } + ], + "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,createVMFromBackup,importVm", + "response": [ + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "true if virtual machine needs to be dynamically scalable", - "length": 255, - "name": "dynamicscalingenabled", - "required": false, - "since": "4.16", - "type": "boolean" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "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", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" - } - ], - "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 list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag value", - "name": "value", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the nic", + "name": "type", + "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 name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "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": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "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" } ], "type": "set" }, - { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "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 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" - }, - { - "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": "VNF details", "name": "vnfdetails", "type": "map" }, { - "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 amount of the vm's CPU currently used", - "name": "cpuused", - "type": "string" - }, - {}, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "the project id of the vm", + "name": "projectid", "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" - }, - { - "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", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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", + "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 ID of the backup offering of the virtual machine", - "name": "backupofferingid", - "type": "string" - }, - { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "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": "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": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -100400,133 +100854,140 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "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" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "device ID of the root volume", + "name": "rootdeviceid", "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" - }, { "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 virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" + }, + { + "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 description of the security group", + "name": "description", + "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 account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", "response": [ { - "description": "security group name", - "name": "securitygroupname", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "description": "resource type", + "name": "resourcetype", "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "the protocol of the security group rule", - "name": "protocol", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "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": "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" + } + ], + "type": "set" + }, + { + "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", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", @@ -100537,13 +100998,8 @@ "name": "tags", "response": [ { - "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" }, { @@ -100552,28 +101008,28 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "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": "the project id the tag belongs to", + "name": "projectid", "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -100582,44 +101038,79 @@ "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" + }, + { + "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" + }, + { + "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" } ], "type": "set" }, + { + "description": "the project name of the group", + "name": "project", + "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 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 egress rules associated with the security group", "name": "egressrule", "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 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 CIDR notation for the base IP address of the security group rule", @@ -100627,18 +101118,18 @@ "type": "string" }, { - "description": "the id of the security group rule", - "name": "ruleid", + "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 ending IP of the security group rule ", - "name": "endport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -100646,8 +101137,8 @@ "name": "tags", "response": [ { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -100656,33 +101147,38 @@ "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": "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" }, { - "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": "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 name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -100691,154 +101187,170 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", - "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", + "description": "the id of the security group rule", + "name": "ruleid", "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" + "description": "account owning the security group rule", + "name": "account", + "type": "string" } ], "type": "set" + } + ], + "type": "set" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "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": "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 list of resource tags associated", + "name": "tags", + "response": [ + { + "description": "the project id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the domain name of the security group", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "tag key name", + "name": "key", "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": "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": "tag key name", - "name": "key", - "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", - "type": "string" - }, - { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - } - ], - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain ID of the security group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "id of the resource", + "name": "resourceid", + "type": "string" } ], "type": "set" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "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": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "User VM type", + "name": "vmtype", "type": "string" }, { @@ -100847,9 +101359,9 @@ "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": "OS name of the vm", @@ -100857,13 +101369,23 @@ "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", + "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": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { @@ -100872,185 +101394,104 @@ "type": "long" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "ssh key-pairs", + "name": "keypairs", "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": "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": "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", + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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": "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 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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "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 format of the template for the virtual machine", + "name": "templateformat", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { @@ -101058,10 +101499,20 @@ "name": "affinitygroup", "response": [ { - "description": "the ID of the affinity group", - "name": "id", + "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": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, { "description": "dedicated resources associated with this affinity group", "name": "dedicatedresources", @@ -101072,24 +101523,19 @@ "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", + "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 domain name of the affinity group", + "name": "domain", "type": "string" }, { @@ -101098,166 +101544,217 @@ "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", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the name of the affinity group", - "name": "name", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project name of the affinity group", + "name": "project", "type": "string" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "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": "Guest vm Boot Type", - "name": "boottype", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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 name of the template for the virtual machine", - "name": "templatename", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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 ISO attached to the virtual machine", - "name": "isoid", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "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", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "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": "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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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 type of the template for the virtual machine", + "name": "templatetype", "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" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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 the availability zone for the virtual machine", + "name": "zonename", + "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" } ], @@ -101269,25 +101766,25 @@ "name": "updateNetworkOffering", "params": [ { - "description": "the name of the network offering", + "description": "sort key of the network offering, integer", "length": 255, - "name": "name", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "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": "domainid", + "name": "keepaliveenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "sort key of the network offering, integer", + "description": "the name of the network offering", "length": 255, - "name": "sortkey", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "maximum number of concurrent connections supported by the network offering", @@ -101297,9 +101794,17 @@ "type": "integer" }, { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "description": "the id of the network offering", + "length": 255, + "name": "id", + "related": "createNetworkOffering,updateNetworkOffering,listNetworkOfferings", + "required": false, + "type": "uuid" + }, + { + "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", "required": false, "type": "string" }, @@ -101312,18 +101817,18 @@ "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 ", + "description": "the display text of the network offering", "length": 255, - "name": "availability", + "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.", + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", "length": 255, - "name": "keepaliveenabled", + "name": "domainid", "required": false, - "type": "boolean" + "type": "string" }, { "description": "update state for the network offering", @@ -101333,56 +101838,53 @@ "type": "string" }, { - "description": "the display text of the network offering", - "length": 255, - "name": "displaytext", + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "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 network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, { - "description": "true if network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", - "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 domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domain", + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the date this network offering was created", + "name": "created", + "type": "date" + }, + { + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { @@ -101399,9 +101901,9 @@ "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", @@ -101414,19 +101916,19 @@ "type": "boolean" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "the provider name", + "name": "name", "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", - "type": "string" + "description": "services for this provider", + "name": "servicelist", + "type": "list" }, { "description": "the destination physical network", @@ -101440,6 +101942,11 @@ "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", @@ -101449,11 +101956,6 @@ "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" @@ -101462,69 +101964,55 @@ "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the name of the network offering", - "name": "name", + "description": "the id of the network offering", + "name": "id", "type": "string" }, { - "description": "true if network offering supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, - {}, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", + "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": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", + "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" + "description": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { "description": "true if network offering supports public access for guest networks", "name": "supportsinternallb", "type": "boolean" }, + {}, { - "description": "the id of the network offering", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" - }, - { - "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 guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "type": "boolean" }, { @@ -101533,23 +102021,23 @@ "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "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": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "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": "availability of the network offering", - "name": "availability", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { @@ -101558,54 +102046,63 @@ "type": "string" }, { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", - "type": "boolean" + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", + "type": "string" }, { - "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" }, - {}, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the internet protocol of the network offering", + "name": "internetprotocol", "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 can be used by VPC networks only", + "name": "forvpc", + "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": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "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": "additional key/value details tied with network offering", - "name": "details", - "type": "map" + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "type": "boolean" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the name of the network offering", + "name": "name", "type": "string" }, { - "description": "the traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", - "name": "traffictype", + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", + "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" } ] @@ -101615,13 +102112,6 @@ "isasync": true, "name": "changeOutOfBandManagementPassword", "params": [ - { - "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "the ID of the host", "length": 255, @@ -101629,26 +102119,17 @@ "related": "declareHostAsDegraded,reconnectHost", "required": true, "type": "uuid" + }, + { + "description": "the new host management interface password of maximum length 16, if none is provided a random password would be used", + "length": 255, + "name": "password", + "required": false, + "type": "string" } ], "related": "enableOutOfBandManagementForHost", "response": [ - { - "description": "the operation result description", - "name": "description", - "type": "string" - }, - { - "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", @@ -101659,45 +102140,61 @@ "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", + "type": "string" + }, + {}, { "description": "the out-of-band management interface username", "name": "username", "type": "string" }, { - "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 port", - "name": "port", - "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 operation result description", + "name": "description", + "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 out-of-band management interface password", "name": "password", "type": "string" }, { - "description": "the ID of the host", - "name": "hostid", + "description": "the out-of-band management interface port", + "name": "port", + "type": "string" + }, + { + "description": "the operation result", + "name": "status", + "type": "boolean" + }, + { + "description": "the out-of-band management interface address", + "name": "address", "type": "string" } ], @@ -101715,6 +102212,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 by key", "length": 255, @@ -101722,6 +102226,13 @@ "required": false, "type": "string" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "list by resource id", "length": 255, @@ -101730,27 +102241,27 @@ "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": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "if set to true, only details marked with display=true, are returned. False by default", + "description": "", "length": 255, - "name": "fordisplay", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "boolean" + "type": "integer" }, { - "description": "list only resources belonging to the domain specified", + "description": "if set to true, only details marked with display=true, are returned. False by default", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "fordisplay", "required": false, - "type": "uuid" + "since": "4.3", + "type": "boolean" }, { "description": "list by resource type", @@ -101760,25 +102271,20 @@ "type": "string" }, { - "description": "List by keyword", + "description": "list by key, value. Needs to be passed only along with key", "length": 255, - "name": "keyword", + "name": "value", "required": false, + "since": "4.4", "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": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -101788,32 +102294,29 @@ "type": "integer" }, { - "description": "list by key, value. Needs to be passed only along with key", + "description": "List by keyword", "length": 255, - "name": "value", + "name": "keyword", "required": false, - "since": "4.4", "type": "string" - }, - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "createProject", - "required": false, - "type": "uuid" } ], "related": "", "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": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, {}, @@ -101823,8 +102326,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -101833,13 +102336,8 @@ "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -101848,19 +102346,18 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, - {}, { - "description": "customer associated with the tag", - "name": "customer", + "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 tag", - "name": "domainid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -101869,8 +102366,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], @@ -101882,69 +102379,47 @@ "name": "createNetworkOffering", "params": [ { - "description": "true if the network offering is IP conserve mode enabled", + "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", "length": 255, - "name": "conservemode", + "name": "fortungsten", "required": false, "type": "boolean" }, { - "description": "services supported by the network offering", + "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": "supportedservices", + "name": "serviceproviderlist", "required": false, - "type": "list" + "type": "map" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "desired service capabilities as part of network offering", "length": 255, - "name": "routingmode", + "name": "servicecapabilitylist", "required": false, - "since": "4.20.0", - "type": "string" + "type": "map" }, { - "description": "set to true if the offering is to be enabled during creation. Default is false", + "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": "enable", - "required": false, - "since": "4.16", - "type": "boolean" - }, - { - "description": "the tags for the network offering.", - "length": 4096, - "name": "tags", + "name": "availability", "required": false, "type": "string" }, { - "description": "true if network offering is meant to be used for Tungsten-Fabric, false otherwise.", - "length": 255, - "name": "fortungsten", - "required": false, - "type": "boolean" - }, - { - "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "description": "true if network offering for NSX network offering supports Load balancer service.", "length": 255, - "name": "ispersistent", + "name": "nsxsupportlb", "required": false, + "since": "4.20.0", "type": "boolean" }, { - "description": "desired service capabilities as part of network offering", - "length": 255, - "name": "servicecapabilitylist", - "required": false, - "type": "map" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "description": "data transfer rate in megabits per second allowed", "length": 255, - "name": "egressdefaultpolicy", + "name": "networkrate", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "true if network offering supports choosing AS number", @@ -101955,55 +102430,50 @@ "type": "boolean" }, { - "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "traffictype", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "list" }, { - "description": "guest type of the network offering: Shared or Isolated", + "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", "length": 255, - "name": "guestiptype", - "required": true, + "name": "networkmode", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "true if network offering supports vlans", + "description": "Name of the provider providing the service", "length": 255, - "name": "specifyvlan", + "name": "provider", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "string" }, { - "description": "true if network offering for NSX network offering supports Load balancer service.", + "description": "true if network offering is meant to be used for NSX, false otherwise.", "length": 255, - "name": "nsxsupportlb", + "name": "fornsx", "required": false, "since": "4.20.0", "type": "boolean" }, { - "description": "the name of the network offering", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "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": "services supported by the network offering", "length": 255, - "name": "serviceproviderlist", + "name": "supportedservices", "required": false, - "type": "map" + "type": "list" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "specifyipranges", "required": false, - "type": "list" + "type": "boolean" }, { "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", @@ -102014,11 +102484,18 @@ "type": "string" }, { - "description": "data transfer rate in megabits per second allowed", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", "length": 255, - "name": "networkrate", + "name": "egressdefaultpolicy", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "true if network offering supports persistent networks; defaulted to false if not specified", + "length": 255, + "name": "ispersistent", + "required": false, + "type": "boolean" }, { "description": "maximum number of concurrent connections supported by the network offering", @@ -102028,51 +102505,60 @@ "type": "integer" }, { - "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": "the display text of the network offering, defaults to the value of 'name'.", "length": 255, - "name": "details", + "name": "displaytext", "required": false, - "since": "4.2.0", - "type": "map" + "type": "string" }, { - "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": "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": "availability", + "name": "keepaliveenabled", "required": false, + "type": "boolean" + }, + { + "description": "the traffic type for the network offering. Supported type in current release is GUEST only", + "length": 255, + "name": "traffictype", + "required": true, "type": "string" }, { - "description": "Name of the provider providing the service", + "description": "the service offering ID used by virtual router provider", "length": 255, - "name": "provider", + "name": "serviceofferingid", + "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { - "description": "Indicates the mode with which the network will operate. Valid option: NATTED or ROUTED", + "description": "true if network offering is meant to be used for VPC, false otherwise.", "length": 255, - "name": "networkmode", + "name": "forvpc", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "description": "the name of the network offering", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "name", + "required": true, + "type": "string" + }, + { + "description": "the tags for the network offering.", + "length": 4096, + "name": "tags", "required": false, - "since": "4.13", - "type": "list" + "type": "string" }, { - "description": "true if network offering is meant to be used for NSX, false otherwise.", + "description": "true if network offering supports vlans", "length": 255, - "name": "fornsx", + "name": "specifyvlan", "required": false, - "since": "4.20.0", "type": "boolean" }, { @@ -102084,118 +102570,128 @@ "type": "boolean" }, { - "description": "true if network offering is meant to be used for VPC, false otherwise.", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "forvpc", + "name": "routingmode", "required": false, - "type": "boolean" + "since": "4.20.0", + "type": "string" }, { - "description": "true if network offering supports specifying ip ranges; defaulted to false if not specified", + "description": "true if the network offering is IP conserve mode enabled", "length": 255, - "name": "specifyipranges", + "name": "conservemode", "required": false, "type": "boolean" }, { - "description": "the service offering ID used by virtual router provider", + "description": "guest type of the network offering: Shared or Isolated", "length": 255, - "name": "serviceofferingid", - "related": "createServiceOffering,updateServiceOffering,listServiceOfferings", - "required": false, - "type": "uuid" + "name": "guestiptype", + "required": true, + "type": "string" }, { - "description": "the display text of the network offering, defaults to the value of 'name'.", + "description": "the ID of the containing zone(s), null for public offerings", "length": 255, - "name": "displaytext", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "since": "4.13", + "type": "list" }, { - "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": "set to true if the offering is to be enabled during creation. Default is false", "length": 255, - "name": "keepaliveenabled", + "name": "enable", "required": false, + "since": "4.16", "type": "boolean" + }, + { + "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": "details", + "required": false, + "since": "4.2.0", + "type": "map" } ], "related": "listNetworkOfferings", "response": [ { - "description": "true if network offering can be used by VPC networks only", - "name": "forvpc", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", "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 supports vlans, false otherwise", - "name": "specifyvlan", + "description": "true if network offering is ip conserve mode enabled", + "name": "conservemode", "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", - "type": "boolean" + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" }, { - "description": "guest type of the network offering, can be Shared or Isolated", - "name": "guestiptype", + "description": "an alternate display text of the network offering.", + "name": "displaytext", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", + "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 traffic type for the network offering, supported types are Public, Management, Control, Guest, Vlan or Storage.", + "name": "traffictype", "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": "additional key/value details tied with network offering", + "name": "details", + "type": "map" }, { - "description": "the id of the network offering", - "name": "id", - "type": "string" + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", + "type": "boolean" }, { - "description": "the tags for the network offering", - "name": "tags", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering supports public access for guest networks", + "name": "supportsinternallb", "type": "boolean" }, { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", - "type": "integer" - }, - { - "description": "true if network offering is ip conserve mode enabled", - "name": "conservemode", + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", "type": "boolean" }, - {}, { "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": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, { "description": "the physical network this belongs to", "name": "physicalnetworkid", @@ -102207,9 +102703,9 @@ "type": "string" }, { - "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", @@ -102217,37 +102713,22 @@ "type": "string" }, { - "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", + "description": "the provider name", + "name": "name", "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": "can this service capability value can be choosable while creatine network offerings", - "name": "canchooseservicecapability", - "type": "boolean" - }, { "description": "the capability value", "name": "value", @@ -102257,6 +102738,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" @@ -102265,60 +102751,69 @@ "type": "list" }, { - "description": "an alternate display text of the network offering.", - "name": "displaytext", + "description": "the tags for the network offering", + "name": "tags", "type": "string" }, { - "description": "the ID of the service offering used by virtual router provider", - "name": "serviceofferingid", + "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 network offering can be used by Tungsten-Fabric networks only", - "name": "fortungsten", + "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 name of the network offering", - "name": "name", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "state of the network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "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 offering can be used by VPC networks only", + "name": "forvpc", "type": "boolean" }, { - "description": "state of the network offering. Can be Disabled/Enabled/Inactive", - "name": "state", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "type": "string" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "true if network offering supports network that span multiple zones", - "name": "supportsstrechedl2subnet", - "type": "boolean" + "description": "the id of the network offering", + "name": "id", + "type": "string" }, { "description": "true if network offering can be used by NSX networks only", @@ -102326,38 +102821,45 @@ "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", + "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": "the ID of the service offering used by virtual router provider", + "name": "serviceofferingid", + "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 name of the network offering", + "name": "name", "type": "string" }, + {}, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", + "type": "boolean" }, { - "description": "availability of the network offering", - "name": "availability", + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" + }, + { + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "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" }, { @@ -102366,18 +102868,13 @@ "type": "string" }, { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", "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 public access for guest networks", - "name": "supportsinternallb", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" } ], @@ -102388,14 +102885,6 @@ "isasync": true, "name": "dedicateCluster", "params": [ - { - "description": "the ID of the containing domain", - "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, - "type": "uuid" - }, { "description": "the name of the account which needs dedication. Must be used with domainId.", "length": 255, @@ -102410,30 +102899,38 @@ "related": "addCluster,updateCluster", "required": true, "type": "uuid" + }, + { + "description": "the ID of the containing domain", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" } ], "related": "listDedicatedClusters", "response": [ - {}, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" }, + {}, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", + "description": "the Dedication Affinity Group ID of the cluster", + "name": "affinitygroupid", "type": "string" }, { @@ -102442,18 +102939,18 @@ "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", + "description": "the domain ID of the cluster", + "name": "domainid", "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 Account ID of the cluster", + "name": "accountid", "type": "string" } ] @@ -102464,32 +102961,32 @@ "name": "createIpForwardingRule", "params": [ { - "description": "the start port for the rule", + "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": "startport", - "required": true, - "type": "integer" + "name": "openfirewall", + "required": false, + "type": "boolean" }, { - "description": "the end port for the rule", + "description": "the start port for the rule", "length": 255, - "name": "endport", - "required": false, + "name": "startport", + "required": true, "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.", + "description": "the protocol for the rule. Valid values are TCP or UDP.", "length": 255, - "name": "cidrlist", - "required": false, - "type": "list" + "name": "protocol", + "required": true, + "type": "string" }, { - "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 end port for the rule", "length": 255, - "name": "openfirewall", + "name": "endport", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "the public IP address ID of the forwarding rule, already associated via associateIp", @@ -102500,44 +102997,70 @@ "type": "uuid" }, { - "description": "the protocol for the rule. Valid values are TCP or UDP.", + "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": "protocol", - "required": true, - "type": "string" + "name": "cidrlist", + "required": false, + "type": "list" } ], "related": "createPortForwardingRule,updatePortForwardingRule", "response": [ {}, { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", + "type": "string" + }, + { + "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 VM name for the port forwarding rule", "name": "virtualmachinename", "type": "string" }, { - "description": "the ID of the port forwarding rule", - "name": "id", + "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": "privateendport", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the guest network the port forwarding rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "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" }, { @@ -102551,53 +103074,52 @@ "type": "string" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "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 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", + "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", + "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 list of resource tags associated with the rule", "name": "tags", "response": [ { - "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": "id of the resource", - "name": "resourceid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "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" }, { @@ -102610,58 +103132,33 @@ "name": "domainpath", "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": "resource type", + "name": "resourcetype", "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" - }, - { - "description": "the vm ip address for the port forwarding rule", - "name": "vmguestip", - "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 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 protocol of the port forwarding rule", - "name": "protocol", - "type": "string" } ] }, @@ -102681,17 +103178,21 @@ "related": "listElastistorVolume", "response": [ { - "description": "graceallowed", - "name": "graceallowed", + "description": "compression", + "name": "compression", "type": "string" }, { - "description": "compression", - "name": "compression", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, - {}, + { + "description": "synchronization", + "name": "sync", + "type": "string" + }, { "description": "the id of the volume", "name": "id", @@ -102703,15 +103204,11 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "synchronization", - "name": "sync", + "description": "graceallowed", + "name": "graceallowed", "type": "string" }, + {}, { "description": "deduplication", "name": "deduplication", @@ -102737,81 +103234,80 @@ "type": "string" }, { - "description": "List quota usage records for the specified usage type", + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", "length": 255, - "name": "type", - "required": false, - "type": "integer" + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": true, + "type": "uuid" }, { - "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": "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": "enddate", + "name": "startdate", "required": true, "type": "date" }, { - "description": "List usage records for the specified account", + "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": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", - "required": false, - "type": "uuid" + "name": "enddate", + "required": true, + "type": "date" }, { - "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.", + "description": "List quota usage records for the specified usage type", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "type", + "required": false, + "type": "integer" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "List usage records for the specified account", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", - "required": true, + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "required": false, "type": "uuid" } ], "related": "", "response": [ - {}, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "domain id", "name": "domain", "type": "long" }, + { + "description": "usage unit", + "name": "unit", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "usage unit", - "name": "unit", - "type": "string" + "description": "usage type", + "name": "type", + "type": "int" }, { "description": "account id", "name": "accountid", "type": "long" }, + {}, { - "description": "account name", - "name": "account", + "description": "usage type name", + "name": "name", "type": "string" }, { - "description": "usage type", - "name": "type", - "type": "int" + "description": "account name", + "name": "account", + "type": "string" }, { "description": "quota consumed", @@ -102819,10 +103315,11 @@ "type": "bigdecimal" }, { - "description": "usage type name", - "name": "name", - "type": "string" - } + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {} ], "since": "4.7.0" }, @@ -102831,6 +103328,14 @@ "isasync": true, "name": "updateLBStickinessPolicy", "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", + "type": "string" + }, { "description": "id of lb stickiness policy", "length": 255, @@ -102846,40 +103351,22 @@ "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": "createLBStickinessPolicy", "response": [ - { - "description": "the id of the zone the Stickiness policy belongs to", - "name": "zoneid", - "type": "string" - }, - { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", - "type": "string" - }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the state of the policy", - "name": "state", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { - "description": "the LB Stickiness policy ID", - "name": "id", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { @@ -102888,8 +103375,8 @@ "type": "map" }, { - "description": "the description of the Stickiness policy", - "name": "description", + "description": "the LB Stickiness policy ID", + "name": "id", "type": "string" }, { @@ -102903,28 +103390,42 @@ "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the state of the policy", + "name": "state", "type": "string" } ], "type": "list" }, + { + "description": "the domain ID of the Stickiness policy", + "name": "domainid", + "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 LB rule ID", - "name": "lbruleid", + "description": "the id of the zone the Stickiness 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 state of the policy", - "name": "state", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -102933,25 +103434,21 @@ "type": "string" }, { - "description": "the description of the Stickiness policy", - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the policy", + "name": "state", "type": "string" }, { - "description": "the domain of the Stickiness policy", - "name": "domain", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" - } + }, + {} ], "since": "4.4" }, @@ -102961,47 +103458,41 @@ "name": "listPods", "params": [ { - "description": "list pods by allocation state", + "description": "list Pods by Zone ID", "length": 255, - "name": "allocationstate", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list Pods by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list pods by allocation state", "length": 255, - "name": "keyword", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "list Pods by ID", - "length": 255, - "name": "id", - "related": "listPods,createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "list Pods by name", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "list Pods by ID", "length": 255, - "name": "page", + "name": "id", + "related": "listPods,createManagementNetworkIpRange", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "the name of the storage access group", @@ -103012,148 +103503,128 @@ "type": "string" }, { - "description": "list Pods by Zone ID", + "description": "flag to display the capacity of the pods", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "showcapacities", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "flag to display the capacity of the pods", + "description": "List by keyword", "length": 255, - "name": "showcapacities", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "createManagementNetworkIpRange", "response": [ - {}, { - "description": "the gateway of the Pod", - "name": "gateway", - "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 Zone name of the Pod", - "name": "zonename", - "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", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "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": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "indicates if range is dedicated for CPVM and SSVM", - "name": "forsystemvms", - "type": "string" - }, - { - "description": "the ending IP for the range", - "name": "endip", - "type": "string" - }, - { - "description": "indicates Vlan ID for the range", - "name": "vlanid", - "type": "string" - } - ], - "type": "list" + "description": "the Zone name of the Pod", + "name": "zonename", + "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 ID of the Pod", + "name": "id", + "type": "string" }, + {}, { - "description": "the netmask of the Pod", - "name": "netmask", + "description": "the gateway of the Pod", + "name": "gateway", "type": "string" }, { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the starting IP for the Pod. This parameter is deprecated, please use 'startip' from ipranges parameter.", + "name": "startip", + "type": "list" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 capacity of the Pod", "name": "capacity", "response": [ { - "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 currently in use", "name": "capacityused", "type": "long" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod name", + "name": "podname", "type": "string" }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, { "description": "the total capacity available", "name": "capacitytotal", "type": "long" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -103161,16 +103632,6 @@ "name": "name", "type": "string" }, - { - "description": "the Zone ID", - "name": "zoneid", - "type": "string" - }, - { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" - }, { "description": "The tag for the capacity type", "name": "tag", @@ -103182,42 +103643,78 @@ "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the allocation state of the Pod", + "name": "allocationstate", "type": "string" }, - {}, { - "description": "indicates Vlan ID for the range. This parameter is deprecated, please use 'vlanid' from ipranges parameter.", - "name": "vlanid", + "description": "the netmask of the Pod", + "name": "netmask", + "type": "string" + }, + { + "description": "the IP ranges for the Pod", + "name": "ipranges", + "response": [ + { + "description": "the ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "the gateway for the range", + "name": "gateway", + "type": "string" + }, + { + "description": "the starting IP for the range", + "name": "startip", + "type": "string" + }, + { + "description": "the CIDR for the range", + "name": "cidr", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + } + ], "type": "list" }, { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "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 for the pod", - "name": "storageaccessgroups", + "description": "the name of the Pod", + "name": "name", "type": "string" } ] @@ -103244,6 +103741,7 @@ } ], "response": [ + {}, {}, { "description": "the current status of the latest async job acting on this object", @@ -103260,7 +103758,6 @@ "name": "displaytext", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -103274,19 +103771,10 @@ "name": "quotaTariffList", "params": [ { - "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": "listall", - "required": false, - "since": "4.18.0.0", - "type": "boolean" - }, - { - "description": "The name of the quota tariff.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, - "since": "4.18.0.0", "type": "string" }, { @@ -103296,20 +103784,6 @@ "required": false, "type": "date" }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" - }, - { - "description": "The quota tariff's id.", - "length": 255, - "name": "id", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -103331,6 +103805,13 @@ "required": false, "type": "integer" }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "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.", "length": 255, @@ -103340,28 +103821,49 @@ "type": "date" }, { - "description": "List by keyword", + "description": "The quota tariff's id.", "length": 255, - "name": "keyword", + "name": "id", + "required": false, + "type": "string" + }, + { + "description": "The name of the quota tariff.", + "length": 255, + "name": "name", "required": false, + "since": "4.18.0.0", "type": "string" + }, + { + "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": "listall", + "required": false, + "since": "4.18.0.0", + "type": "boolean" } ], "related": "", "response": [ { - "description": "position in the execution sequence for tariffs of the same type", - "name": "position", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "description", - "name": "description", + "description": "the ID of the tariff", + "name": "id", "type": "string" }, { - "description": "activation rule of the quota tariff", - "name": "activationRule", + "description": "usage type description", + "name": "usageTypeDescription", + "type": "string" + }, + { + "description": "usageUnit", + "name": "usageUnit", "type": "string" }, { @@ -103370,19 +103872,18 @@ "type": "bigdecimal" }, { - "description": "currency", - "name": "currency", + "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 start date of the quota tariff", + "name": "effectiveDate", "type": "date" }, - {}, { - "description": "the end date of the quota tariff", - "name": "endDate", + "description": "when the quota tariff was removed", + "name": "removed", "type": "date" }, { @@ -103391,50 +103892,46 @@ "type": "string" }, { - "description": "the start date of the quota tariff", - "name": "effectiveDate", - "type": "date" - }, - { - "description": "name", - "name": "name", + "description": "currency", + "name": "currency", "type": "string" }, + {}, + {}, { - "description": "usageUnit", - "name": "usageUnit", + "description": "activation rule of the quota tariff", + "name": "activationRule", "type": "string" }, { - "description": "usage type description", - "name": "usageTypeDescription", + "description": "name", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "usageDiscriminator", + "name": "usageDiscriminator", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "position in the execution sequence for tariffs of the same type", + "name": "position", "type": "integer" }, - { - "description": "the ID of the tariff", - "name": "id", - "type": "string" - }, - {}, { "description": "usageType", "name": "usageType", "type": "int" }, { - "description": "usageDiscriminator", - "name": "usageDiscriminator", + "description": "description", + "name": "description", "type": "string" + }, + { + "description": "the end date of the quota tariff", + "name": "endDate", + "type": "date" } ], "since": "4.7.0" @@ -103454,26 +103951,26 @@ } ], "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" }, {} ] @@ -103493,170 +103990,30 @@ } ], "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": "Lists IPv4 subnets for zone.", - "isasync": false, - "name": "listIpv4SubnetsForZone", - "params": [ - { - "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": false, - "type": "uuid" - }, - { - "description": "UUID of zone to which the IPv4 subnet belongs to.", - "length": 255, - "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, + "description": "any text associated with the success or failure", + "name": "displaytext", "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" + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" } ], - "since": "4.20.0" + "since": "4.21.0" }, { "description": "Adds account to a project", @@ -103664,9 +104021,9 @@ "name": "addAccountToProject", "params": [ { - "description": "name of the account to be added to the project", + "description": "email to which invitation to the project is going to be sent", "length": 255, - "name": "account", + "name": "email", "required": false, "type": "string" }, @@ -103686,9 +104043,9 @@ "type": "string" }, { - "description": "email to which invitation to the project is going to be sent", + "description": "name of the account to be added to the project", "length": 255, - "name": "email", + "name": "account", "required": false, "type": "string" }, @@ -103702,16 +104059,17 @@ } ], "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", @@ -103719,11 +104077,10 @@ "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": "3.0.0" }, @@ -103733,22 +104090,18 @@ "name": "listSnapshots", "params": [ { - "description": "ID of the image or image cache store", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "imagestoreid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "isrecursive", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { - "description": "ID of the storage pool", + "description": "", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "page", "required": false, - "since": "4.19", - "type": "uuid" + "type": "integer" }, { "description": "list snapshots by location type. Used only when showunique=false. Valid location types: 'primary', 'secondary'. Default is empty", @@ -103759,148 +104112,157 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "valid values are MANUAL or RECURRING.", "length": 255, - "name": "projectid", - "related": "createProject", + "name": "snapshottype", "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": "list snapshots by zone id", "length": 255, - "name": "listall", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "", + "description": "lists snapshot by snapshot ID", "length": 255, - "name": "pagesize", + "name": "id", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "valid values are MANUAL or RECURRING.", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "snapshottype", + "name": "tags", "required": false, - "type": "string" + "type": "map" }, { - "description": "", + "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", "length": 255, - "name": "page", + "name": "intervaltype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "If set to false, list templates across zones and their storages", + "description": "the IDs of the snapshots, mutually exclusive with id", "length": 255, - "name": "showunique", + "name": "ids", + "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", "required": false, - "since": "4.19.0", - "type": "boolean" + "since": "4.9", + "type": "list" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "the ID of the disk volume", "length": 255, - "name": "isrecursive", + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "required": false, - "type": "boolean" + "type": "uuid" }, { - "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,listDomains,listDomains", + "name": "projectid", + "related": "createProject", "required": false, "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "ID of the image or image cache store", "length": 255, - "name": "tags", + "name": "imagestoreid", + "related": "addSecondaryStorage,listSwifts,addImageStore", "required": false, - "type": "map" + "since": "4.19", + "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 disk volume", + "description": "", "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,destroyVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "lists snapshot by snapshot ID", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "id", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "the IDs of the snapshots, mutually exclusive with id", + "description": "lists snapshot by snapshot name", "length": 255, - "name": "ids", - "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots,listSnapshots", + "name": "name", "required": false, - "since": "4.9", - "type": "list" + "type": "string" }, { - "description": "List by keyword", + "description": "If set to false, list templates across zones and their storages", "length": 255, - "name": "keyword", + "name": "showunique", "required": false, - "type": "string" + "since": "4.19.0", + "type": "boolean" }, { - "description": "valid values are HOURLY, DAILY, WEEKLY, and MONTHLY.", + "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": "intervaltype", + "name": "listall", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list snapshots by zone id", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "lists snapshot by snapshot name", + "description": "ID of the storage pool", "length": 255, - "name": "name", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" } ], "related": "createSnapshotFromVMSnapshot,copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "state of the disk volume", - "name": "volumestate", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "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" }, { @@ -103914,28 +104276,29 @@ "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" + "description": "the type of the snapshot", + "name": "snapshottype", + "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, + {}, { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { @@ -103944,38 +104307,59 @@ "type": "long" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" }, + {}, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "the domain ID of the snapshot's account", + "name": "domainid", + "type": "string" }, { - "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": "the project id of the snapshot", - "name": "projectid", + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" + }, + { + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "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": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "type of the disk volume", + "name": "volumetype", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { @@ -103983,33 +104367,33 @@ "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "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 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 project id the tag belongs to", - "name": "projectid", + "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" }, { @@ -104023,106 +104407,219 @@ "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": " the date the snapshot was created", + "name": "created", + "type": "date" + }, + { + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" + }, + { + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", - "name": "revertable", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, - {}, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } + ] + }, + { + "description": "Lists IPv4 subnets for zone.", + "isasync": false, + "name": "listIpv4SubnetsForZone", + "params": [ + { + "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": "ID of the disk volume", - "name": "volumeid", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain ID which the IPv4 subnet is dedicated to.", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" }, { - "description": "id of the availability zone", + "description": "UUID of the IPv4 subnet.", + "length": 255, + "name": "id", + "related": "listIpv4SubnetsForZone,dedicateIpv4SubnetForZone", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "project who which the IPv4 subnet is dedicated to", + "length": 255, + "name": "projectid", + "related": "createProject", + "required": false, + "type": "uuid" + }, + { + "description": "UUID of zone to which the IPv4 subnet belongs to.", + "length": 255, "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "CIDR of the IPv4 subnet.", + "length": 255, + "name": "subnet", + "required": false, "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "dedicateIpv4SubnetForZone", + "response": [ + { + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "id of the guest IPv4 subnet", + "name": "id", + "type": "string" + }, + { + "description": "the domain ID of the IPv4 subnet", + "name": "domainid", + "type": "string" + }, + { + "description": "the project id of the IPv4 subnet", + "name": "projectid", "type": "string" }, {}, { - "description": "name of the snapshot", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the project name of the IPv4 subnet", + "name": "project", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "guest IPv4 subnet", + "name": "subnet", + "type": "string" + }, + { + "description": "the account of the IPv4 subnet", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the IPv4 subnet", + "name": "domain", "type": "string" } - ] + ], + "since": "4.20.0" }, { "description": "Delete the extensions", @@ -104138,7 +104635,7 @@ "type": "uuid" }, { - "description": "Whether cleanup entry-point files for the extension", + "description": "Whether to cleanup files for the extension. If true, the extension files will be deleted from all the management servers.", "length": 255, "name": "cleanup", "related": "listExtensions,deleteExtension,updateExtension,unregisterExtension", @@ -104149,40 +104646,61 @@ "related": "listExtensions,updateExtension,unregisterExtension", "response": [ { - "description": "Name of the extension", - "name": "name", + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + {}, + {}, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" }, { - "description": "Removal timestamp of the extension, if applicable", - "name": "removed", - "type": "date" + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" }, { "description": "Description of the extension", "name": "description", "type": "string" }, - {}, - { - "description": "ID of the extension", - "name": "id", - "type": "string" - }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" + "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": "True if the extension is added by admin", + "name": "isuserdefined", + "type": "boolean" }, {}, { @@ -104190,9 +104708,9 @@ "name": "resources", "response": [ { - "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": "Name of the resource associated with this mapping", @@ -104200,9 +104718,9 @@ "type": "string" }, { - "description": "Type of the resource", - "name": "type", - "type": "string" + "description": "the details of the resource map", + "name": "details", + "type": "map" }, { "description": "Creation timestamp of the mapping", @@ -104210,43 +104728,22 @@ "type": "date" }, { - "description": "ID of the resource associated with the extension", - "name": "id", + "description": "Type of the resource", + "name": "type", "type": "string" } ], "type": "list" }, { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - { - "description": "The path of the entry point fo the extension", - "name": "path", - "type": "string" - }, - {}, - { - "description": "The state of the extension", - "name": "state", + "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": "True if the extension is added by admin", - "name": "isuserdefined", - "type": "boolean" - }, - { - "description": "Type of the extension", - "name": "type", - "type": "string" + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" } ], "since": "4.21.0" @@ -104256,14 +104753,6 @@ "isasync": true, "name": "migrateResourceToAnotherSecondaryStorage", "params": [ - { - "description": "id of the destination secondary storage pool to which the resources are to be migrated", - "length": 255, - "name": "destpool", - "related": "addSecondaryStorage,listSwifts,addImageStore", - "required": true, - "type": "uuid" - }, { "description": "id(s) of the snapshots to be migrated", "length": 255, @@ -104272,11 +104761,19 @@ "required": false, "type": "list" }, + { + "description": "id of the destination secondary storage pool to which the resources are to be migrated", + "length": 255, + "name": "destpool", + "related": "addSecondaryStorage,listSwifts,addImageStore", + "required": true, + "type": "uuid" + }, { "description": "id(s) of the templates to be migrated", "length": 255, "name": "templates", - "related": "prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,updateIso,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "list" }, @@ -104291,32 +104788,32 @@ ], "related": "migrateSecondaryStorageData", "response": [ - {}, - { - "description": "Response message from migration of secondary storage data objects", - "name": "message", - "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": "Type of migration requested for", "name": "migrationtype", "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": "Response message from migration of secondary storage data objects", + "name": "message", + "type": "string" } ], "since": "4.19.0" @@ -104327,19 +104824,18 @@ "name": "deleteSSHKeyPair", "params": [ { - "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" }, { - "description": "the domain ID associated with the keypair", + "description": "the account associated with the keypair. Must be used with the domainId parameter.", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the project associated with keypair", @@ -104350,21 +104846,15 @@ "type": "uuid" }, { - "description": "Name of the keypair", + "description": "the domain ID associated with the keypair", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "domainid", + "related": "createDomain,listDomains,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", @@ -104375,11 +104865,18 @@ "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" - } + }, + {} ] }, { @@ -104390,7 +104887,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, @@ -104412,24 +104909,13 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ - {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "The user's principle", - "name": "principal", - "type": "string" - }, { "description": "The user's email", "name": "email", @@ -104441,15 +104927,26 @@ "type": "string" }, { - "description": "The user's firstname", - "name": "firstname", + "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", "type": "string" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "The user's firstname", + "name": "firstname", + "type": "string" + }, {}, { "description": "The user's username", @@ -104457,13 +104954,13 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "The user's domain", - "name": "domain", + "description": "The user's principle", + "name": "principal", "type": "string" } ], @@ -104485,41 +104982,21 @@ ], "related": "prepareForShutdown", "response": [ - { - "description": "Indicates whether maintenance has been initiated", - "name": "maintenanceinitiated", - "type": "boolean" - }, { "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": "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 number of host agents this management server is responsible for", @@ -104532,11 +105009,31 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 maintenance has been initiated", + "name": "maintenanceinitiated", + "type": "boolean" + }, + { + "description": "Indicates whether a shutdown has been triggered", + "name": "shutdowntriggered", + "type": "boolean" + }, + { + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" + } ], "since": "4.19.0" }, @@ -104545,13 +105042,6 @@ "isasync": true, "name": "createTungstenFabricLogicalRouter", "params": [ - { - "description": "Tungsten-Fabric logical router name", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -104559,10 +105049,34 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "Tungsten-Fabric logical router name", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "response": [ + { + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + {}, + {}, + { + "description": "Tungsten-Fabric logical router uuid", + "name": "uuid", + "type": "string" + }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "Tungsten-Fabric logical router name", "name": "name", @@ -104573,32 +105087,15 @@ "name": "jobstatus", "type": "integer" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - {}, - { - "description": "Tungsten-Fabric logical router 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 network name", - "name": "network", - "type": "list" } ] }, @@ -104619,68 +105116,89 @@ "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "response": [ { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "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", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + {}, + { + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "the shared filesystem provider", + "name": "provider", "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": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -104689,24 +105207,35 @@ "type": "long" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + {}, + { + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ - { - "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": "Id of the vm to which the nic belongs", "name": "virtualmachineid", @@ -104718,18 +105247,18 @@ "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": "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" }, { @@ -104738,23 +105267,8 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "type": "string" - }, - { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -104763,14 +105277,14 @@ "type": "integer" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "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 IPv6 address of network", + "name": "ip6address", + "type": "string" }, { "description": "Type of adapter if available", @@ -104783,58 +105297,68 @@ "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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", - "name": "nsxlogicalswitch", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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 extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -104843,31 +105367,66 @@ "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "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": "MTU configured on the NIC", "name": "mtu", "type": "integer" + }, + { + "description": "true if nic is default, false otherwise", + "name": "macaddress", + "type": "string" } ], "type": "list" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "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": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { @@ -104875,28 +105434,28 @@ "name": "tags", "response": [ { - "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" }, { - "description": "tag value", - "name": "value", + "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": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -104905,18 +105464,18 @@ "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -104925,108 +105484,61 @@ "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": "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": "the shared filesystem provider", - "name": "provider", - "type": "string" - }, - {}, { "description": "disk offering ID for the shared filesystem", "name": "diskofferingid", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" - }, - { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "the disk utilization", - "name": "utilization", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { @@ -105035,24 +105547,9 @@ "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", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" } ], "since": "4.20.0" @@ -105062,20 +105559,6 @@ "isasync": true, "name": "createTungstenFabricFirewallRule", "params": [ - { - "description": "Tungsten-Fabric firewall rule service group uuid", - "length": 255, - "name": "servicegroupuuid", - "required": true, - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule direction", - "length": 255, - "name": "direction", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -105092,44 +105575,44 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric source network", + "description": "Tungsten-Fabric firewall rule destination address group uuid", "length": 255, - "name": "srcnetworkuuid", + "name": "destaddressgroupuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination address group uuid", + "description": "Tungsten-Fabric firewall rule service group uuid", "length": 255, - "name": "destaddressgroupuuid", - "required": false, + "name": "servicegroupuuid", + "required": true, "type": "string" }, { - "description": "the sequence of Tungsten-Fabric firewall rule", + "description": "Tungsten-Fabric firewall rule source tag uuid", "length": 255, - "name": "sequence", - "required": true, - "type": "integer" + "name": "srctaguuid", + "required": false, + "type": "string" }, { - "description": "Tungsten-Fabric firewall rule name", + "description": "the uuid of Tungsten-Fabric source network", "length": 255, - "name": "name", - "required": true, + "name": "srcnetworkuuid", + "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", + "description": "Tungsten-Fabric firewall rule name", "length": 255, - "name": "action", + "name": "name", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group uuid", + "description": "the uuid of Tungsten-Fabric destination network", "length": 255, - "name": "srcaddressgroupuuid", + "name": "destnetworkuuid", "required": false, "type": "string" }, @@ -105141,23 +105624,37 @@ "type": "string" }, { - "description": "the uuid of Tungsten-Fabric destination network", + "description": "the sequence of Tungsten-Fabric firewall rule", "length": 255, - "name": "destnetworkuuid", + "name": "sequence", + "required": true, + "type": "integer" + }, + { + "description": "Tungsten-Fabric firewall rule source address group uuid", + "length": 255, + "name": "srcaddressgroupuuid", "required": false, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag uuid", + "description": "Tungsten-Fabric firewall rule action", "length": 255, - "name": "desttaguuid", - "required": false, + "name": "action", + "required": true, "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source tag uuid", + "description": "Tungsten-Fabric firewall rule direction", "length": 255, - "name": "srctaguuid", + "name": "direction", + "required": true, + "type": "string" + }, + { + "description": "Tungsten-Fabric firewall rule destination tag uuid", + "length": 255, + "name": "desttaguuid", "required": false, "type": "string" } @@ -105165,55 +105662,59 @@ "related": "listTungstenFabricFirewallRule", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Tungsten-Fabric firewall rule tag type", + "name": "tagtype", "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric firewall rule action", + "name": "action", + "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule name", - "name": "name", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "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 firewall rule destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule source address group", - "name": "srcaddressgroup", + "description": "Tungsten-Fabric firewall rule direction", + "name": "direction", "type": "string" }, - {}, { - "description": "Tungsten-Fabric firewall rule source tag", - "name": "srctag", + "description": "Tungsten-Fabric firewall rule destination address group", + "name": "destaddressgroup", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", + "description": "Tungsten-Fabric firewall rule destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, + { + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule service group", + "name": "servicegroup", "type": "string" }, { @@ -105221,9 +105722,10 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule source address group", + "name": "srcaddressgroup", "type": "string" }, { @@ -105232,18 +105734,13 @@ "type": "string" }, { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule name", + "name": "name", "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" } ] @@ -105254,124 +105751,124 @@ "name": "listConfigurations", "params": [ { - "description": "the ID of the Image Store to update the parameter value for corresponding image store", + "description": "the ID of the Domain to update the parameter value for corresponding domain", "length": 255, - "name": "imagestoreuuid", - "related": "addSecondaryStorage,listSwifts,addImageStore", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" }, { - "description": "lists configuration by parent name (primarily used for UI)", + "description": "List by keyword", "length": 255, - "name": "parent", + "name": "keyword", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "lists configuration by subgroup name (primarily used for UI)", + "description": "", "length": 255, - "name": "subgroup", + "name": "pagesize", "required": false, - "since": "4.18.0", - "type": "string" + "type": "integer" }, { - "description": "lists configuration by group name (primarily used for UI)", + "description": "the ID of the Cluster to update the parameter value for corresponding cluster", "length": 255, - "name": "group", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, - "since": "4.18.0", - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "the ID of the Account to update the parameter value for corresponding account", "length": 255, - "name": "keyword", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the Account to update the parameter value for corresponding account", + "description": "the ID of the Storage pool to update the parameter value for corresponding storage pool", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,markDefaultZoneForAccount,listAccounts", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, "type": "uuid" }, { - "description": "lists configurations by category", + "description": "lists configuration by parent name (primarily used for UI)", "length": 255, - "name": "category", + "name": "parent", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "lists configuration by name", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the Zone to update the parameter value for corresponding zone", + "description": "lists configuration by subgroup name (primarily used for UI)", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "subgroup", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "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": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "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": "the ID of the Storage pool to update the parameter value for corresponding storage pool", + "description": "lists configuration by group name (primarily used for UI)", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "name": "group", "required": false, - "type": "uuid" + "since": "4.18.0", + "type": "string" }, { - "description": "", + "description": "the ID of the Zone to update the parameter value for corresponding zone", "length": 255, - "name": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the value of the configuration", - "name": "value", + "description": "the category of the configuration", + "name": "category", "type": "string" }, { - "description": "true if the configuration is dynamic", - "name": "isdynamic", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { "description": "scope(zone/cluster/pool/account) of the parameter that needs to be updated", @@ -105379,8 +105876,13 @@ "type": "string" }, { - "description": "the possible options of the configuration value", - "name": "options", + "description": "the subgroup of the configuration", + "name": "subgroup", + "type": "string" + }, + { + "description": "the name of the parent configuration", + "name": "parent", "type": "string" }, { @@ -105389,28 +105891,30 @@ "type": "string" }, { - "description": "the default value of the configuration", - "name": "defaultvalue", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the description of the configuration", - "name": "description", + "description": "the value of the configuration", + "name": "value", "type": "string" }, + {}, { - "description": "the component of the configuration", - "name": "component", + "description": "the display text of the configuration", + "name": "displaytext", "type": "string" }, + {}, { "description": "the value of the configuration", "name": "id", "type": "long" }, { - "description": "the category of the configuration", - "name": "category", + "description": "the description of the configuration", + "name": "description", "type": "string" }, { @@ -105419,37 +105923,30 @@ "type": "string" }, { - "description": "the display text of the configuration", - "name": "displaytext", + "description": "the default value of the configuration", + "name": "defaultvalue", "type": "string" }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { - "description": "the type of the configuration value", - "name": "type", - "type": "string" + "description": "true if the configuration is dynamic", + "name": "isdynamic", + "type": "boolean" }, { - "description": "the subgroup of the configuration", - "name": "subgroup", + "description": "the component of the configuration", + "name": "component", "type": "string" }, { - "description": "the name of the parent configuration", - "name": "parent", + "description": "the possible options of the configuration value", + "name": "options", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the configuration value", + "name": "type", "type": "string" - }, - {} + } ] }, { @@ -105458,11 +105955,12 @@ "name": "scaleKubernetesCluster", "params": [ { - "description": "number of Kubernetes cluster nodes", + "description": "the IDs of the nodes to be removed", "length": 255, - "name": "size", + "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,createVMFromBackup,importVm", "required": false, - "type": "long" + "type": "list" }, { "description": "the ID of the service offering for the virtual machines in the cluster.", @@ -105472,6 +105970,20 @@ "required": false, "type": "uuid" }, + { + "description": "Whether autoscaling is enabled for the cluster", + "length": 255, + "name": "autoscalingenabled", + "required": false, + "type": "boolean" + }, + { + "description": "Minimum number of worker nodes in the cluster", + "length": 255, + "name": "minsize", + "required": false, + "type": "long" + }, { "description": "the ID of the Kubernetes cluster", "length": 255, @@ -105480,13 +105992,6 @@ "required": true, "type": "uuid" }, - { - "description": "Minimum number of worker nodes in the cluster", - "length": 255, - "name": "minsize", - "required": false, - "type": "long" - }, { "description": "Maximum number of worker nodes in the cluster", "length": 255, @@ -105503,26 +106008,28 @@ "type": "map" }, { - "description": "the IDs of the nodes to be removed", - "length": 255, - "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": "list" - }, - { - "description": "Whether autoscaling is enabled for the cluster", + "description": "number of Kubernetes cluster nodes", "length": 255, - "name": "autoscalingenabled", + "name": "size", "required": false, - "type": "boolean" + "type": "long" } ], "related": "createKubernetesCluster,startKubernetesCluster", "response": [ { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", + "type": "string" + }, + { + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { @@ -105531,79 +106038,99 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" + }, + { + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", "type": "string" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", "type": "string" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, + { + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" + }, { "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", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", "type": "long" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "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", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the memory the Kubernetes cluster", - "name": "memory", + "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 master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" }, { - "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": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" + }, + { + "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" }, { @@ -105612,155 +106139,135 @@ "type": "map" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "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 type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "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", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "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": "the name of the Kubernetes cluster", - "name": "name", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the memory the Kubernetes cluster", + "name": "memory", "type": "string" }, { - "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", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, + {}, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "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", + "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingname", "type": "string" }, - {}, { "description": "the ID of the template of the Kubernetes cluster", "name": "templateid", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", + "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": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" } ] }, @@ -105787,65 +106294,79 @@ ], "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ - {}, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the Pod name for the router", + "name": "podname", + "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "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": "CPU arch of the router", - "name": "arch", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -105854,13 +106375,43 @@ "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the account associated with the router", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", + "type": "string" + }, + { + "description": "CPU arch of the router", + "name": "arch", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { @@ -105869,68 +106420,197 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", "type": "boolean" }, { - "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 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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + {}, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the Zone ID for the router", + "name": "zoneid", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + {}, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", "type": "string" }, + { + "description": "the state of the router", + "name": "state", + "type": "state" + }, { "description": "the Zone name for the router", "name": "zonename", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the id of the router", + "name": "id", + "type": "string" + }, + { + "description": "the template ID for the router", + "name": "templateid", + "type": "string" + }, + { + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "the date and time the router was created", + "name": "created", + "type": "date" + }, + { + "description": "Last executed health check result for the router", + "name": "healthcheckresults", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the name of the health check on the router", + "name": "checkname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "result of the health check if available", + "name": "success", + "type": "boolean" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "detailed response generated on running health check", + "name": "details", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "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 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", "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 broadcast uri of the nic", @@ -105938,38 +106618,38 @@ "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": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", "type": "list" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "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": "the type of the nic", - "name": "type", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { @@ -105978,43 +106658,53 @@ "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": "the name of the corresponding network", - "name": "networkname", + "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 vpc to which the nic belongs", + "name": "vpcid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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" }, { @@ -106022,241 +106712,63 @@ "name": "nsxlogicalswitchport", "type": "string" }, + { + "description": "the gateway of the nic", + "name": "gateway", + "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", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", "type": "integer" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Type of adapter if available", + "name": "adaptertype", "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 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": "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 name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "role of the domain router", - "name": "role", - "type": "string" - }, - { - "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": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "result of the health check", - "name": "success", - "type": "boolean" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the type of the nic", + "name": "type", "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" } ], - "type": "list" - }, - { - "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" + "type": "set" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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" } ] }, @@ -106275,28 +106787,28 @@ } ], "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": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - }, - {} + } ] }, { @@ -106304,13 +106816,6 @@ "isasync": true, "name": "updateTrafficType", "params": [ - { - "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", - "length": 255, - "name": "hypervnetworklabel", - "required": false, - "type": "string" - }, { "description": "The network name label of the physical device dedicated to this traffic on a VMware host", "length": 255, @@ -106319,9 +106824,9 @@ "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 Hyperv host", "length": 255, - "name": "ovm3networklabel", + "name": "hypervnetworklabel", "required": false, "type": "string" }, @@ -106332,6 +106837,14 @@ "required": false, "type": "string" }, + { + "description": "traffic type id", + "length": 255, + "name": "id", + "related": "addTrafficType,updateTrafficType", + "required": true, + "type": "uuid" + }, { "description": "The network name label of the physical device dedicated to this traffic on a KVM host", "length": 255, @@ -106340,41 +106853,29 @@ "type": "string" }, { - "description": "traffic type id", + "description": "The network name of the physical device dedicated to this traffic on an OVM3 host", "length": 255, - "name": "id", - "related": "addTrafficType,updateTrafficType", - "required": true, - "type": "uuid" + "name": "ovm3networklabel", + "required": false, + "type": "string" } ], "related": "addTrafficType", "response": [ - {}, { "description": "id of the network provider", "name": "id", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", - "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" }, - {}, { - "description": "The network name label of the physical device dedicated to this traffic on a HyperV host", - "name": "hypervnetworklabel", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -106382,25 +106883,36 @@ "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 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" }, { - "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 network name label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" } ], "since": "3.0.0" @@ -106411,109 +106923,114 @@ "name": "listConditions", "params": [ { - "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": "createProject", + "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": "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": "the ID of the policy", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "policyid", + "related": "listAutoScalePolicies", "required": false, "type": "uuid" }, { - "description": "", + "description": "Counter-id of the condition.", "length": 255, - "name": "page", + "name": "counterid", + "related": "createCounter", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the policy", + "description": "List by keyword", "length": 255, - "name": "policyid", - "related": "listAutoScalePolicies", + "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": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "ID of the Condition.", "length": 255, - "name": "account", + "name": "id", + "related": "listConditions", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "keyword", + "name": "projectid", + "related": "createProject", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "createDomain,listDomains,listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Counter-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": "counterid", - "related": "createCounter", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "ID of the Condition.", + "description": "", "length": 255, - "name": "id", - "related": "listConditions", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "Threshold Value for the counter.", - "name": "threshold", - "type": "long" + "description": "Relational Operator to be used with threshold.", + "name": "relationaloperator", + "type": "string" }, { - "description": "the project name of the Condition", - "name": "project", - "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 Condition.", - "name": "projectid", + "description": "zone id of counter", + "name": "zoneid", + "type": "string" + }, + { + "description": "the project name of the Condition", + "name": "project", "type": "string" }, {}, { - "description": "the domain id of the Condition owner", - "name": "domainid", + "description": "the Name of the Counter.", + "name": "countername", "type": "string" }, { @@ -106522,55 +107039,50 @@ "type": "counterresponse" }, { - "description": "the owner of the Condition.", - "name": "account", + "description": "the domain id of the Condition owner", + "name": "domainid", "type": "string" }, - {}, { - "description": "the Id of the Counter.", - "name": "counterid", + "description": "the project id of the Condition.", + "name": "projectid", "type": "string" }, { - "description": "zone id of counter", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Relational Operator to be used with threshold.", - "name": "relationaloperator", + "description": "the id of the Condition", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "Threshold Value for the counter.", + "name": "threshold", + "type": "long" }, { - "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": "path of the domain to which the Condition owner belongs", + "name": "domainpath", "type": "string" }, + {}, { - "description": "the Name of the Counter.", - "name": "countername", + "description": "the owner of the Condition.", + "name": "account", "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" } ] }, @@ -106579,6 +107091,14 @@ "isasync": false, "name": "addBackupRepository", "params": [ + { + "description": "backups on this repository can be used to create Instances on all Zones", + "length": 255, + "name": "crosszoneinstancecreation", + "required": false, + "since": "4.22.0", + "type": "boolean" + }, { "description": "address of the backup repository", "length": 255, @@ -106587,16 +107107,24 @@ "type": "string" }, { - "description": "backup repository provider", + "description": "shared storage mount options", "length": 255, - "name": "provider", + "name": "mountopts", "required": false, "type": "string" }, { - "description": "shared storage mount options", + "description": "ID of the zone where the backup repository is to be added for taking backups", "length": 255, - "name": "mountopts", + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "backup repository provider", + "length": 255, + "name": "provider", "required": false, "type": "string" }, @@ -106608,30 +107136,37 @@ "type": "long" }, { - "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", + "description": "name of the backup repository", "length": 255, - "name": "type", + "name": "name", "required": true, "type": "string" }, { - "description": "ID of the zone where the backup repository is to be added", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "name of the backup repository", + "description": "type of the backup repository storage. Supported values: nfs, cephfs, cifs", "length": 255, - "name": "name", + "name": "type", "required": true, "type": "string" } ], "related": "", "response": [ + { + "description": "the address / url of the backup repository", + "name": "address", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of the backup repository", + "name": "id", + "type": "string" + }, { "description": "the Zone ID of the backup repository", "name": "zoneid", @@ -106643,9 +107178,14 @@ "type": "integer" }, { - "description": "capacity of the backup repository", - "name": "capacitybytes", - "type": "long" + "description": "the date and time the backup repository was added", + "name": "created", + "type": "date" + }, + { + "description": "name of the provider", + "name": "provider", + "type": "string" }, { "description": "backup type", @@ -106653,9 +107193,9 @@ "type": "string" }, { - "description": "the address / url of the backup repository", - "name": "address", - "type": "string" + "description": "capacity of the backup repository", + "name": "capacitybytes", + "type": "long" }, { "description": "the name of the backup repository", @@ -106667,27 +107207,12 @@ "name": "zonename", "type": "string" }, - { - "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": "the date and time the backup repository was added", - "name": "created", - "type": "date" - }, {}, {}, { - "description": "name of the provider", - "name": "provider", - "type": "string" + "description": "the backups in this repository can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" } ], "since": "4.20.0" @@ -106723,33 +107248,33 @@ ], "related": "", "response": [ + { + "description": "Type of migration requested for", + "name": "migrationtype", + "type": "string" + }, { "description": "true if operation is executed successfully", "name": "success", "type": "boolean" }, + {}, + {}, { - "description": "Type of migration requested for", - "name": "migrationtype", + "description": "Response message from migration of secondary storage data objects", + "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" }, - {}, { - "description": "Response message from migration of secondary storage data objects", - "name": "message", - "type": "string" - }, - {} + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + } ], "since": "4.15.0" }, @@ -106758,14 +107283,6 @@ "isasync": true, "name": "destroyVolume", "params": [ - { - "description": "If true is passed, the volume is expunged immediately. False by default.", - "length": 255, - "name": "expunge", - "required": false, - "since": "4.6.0", - "type": "boolean" - }, { "description": "The ID of the volume", "length": 255, @@ -106773,55 +107290,47 @@ "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, + "name": "expunge", + "required": false, + "since": "4.6.0", + "type": "boolean" } ], "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", "response": [ { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, - { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { "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": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" }, { "description": "ID of the disk volume", @@ -106829,165 +107338,110 @@ "type": "string" }, { - "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": "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": "shared or local storage", - "name": "storagetype", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, - {}, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, { "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": "size of the disk volume", - "name": "size", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" - }, - { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "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": "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": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "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", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "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": "name of the virtual machine", - "name": "vmname", + "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", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" - }, - { - "description": "the status of the volume", - "name": "status", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "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 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": "type of the virtual machine", + "name": "vmtype", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -106995,23 +107449,24 @@ "type": "integer" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { @@ -107020,97 +107475,102 @@ "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "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": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "description": "the path of the volume", - "name": "path", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" }, { "description": "the list of resource tags associated", "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": "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" }, { - "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": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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" }, { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -107119,52 +107579,72 @@ "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 name of the template for the virtual machine", - "name": "templatename", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "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 vpn", + "name": "project", "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 display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "name of the disk volume", + "name": "name", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" }, { "description": "IO requests write rate of the disk volume per the disk offering", @@ -107172,34 +107652,79 @@ "type": "long" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "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": "id of the virtual machine", "name": "virtualmachineid", "type": "string" }, + { + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "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 service offering for root disk", - "name": "serviceofferingname", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "size of the disk volume", + "name": "size", + "type": "long" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "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" } ], "since": "4.14.0" @@ -107209,6 +107734,14 @@ "isasync": true, "name": "addTrafficType", "params": [ + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "updatePhysicalNetwork", + "required": true, + "type": "uuid" + }, { "description": "The network name label of the physical device dedicated to this traffic on a Hyperv host", "length": 255, @@ -107217,10 +107750,10 @@ "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "description": "the trafficType to be added to the physical network", "length": 255, - "name": "vmwarenetworklabel", - "required": false, + "name": "traffictype", + "required": true, "type": "string" }, { @@ -107231,16 +107764,9 @@ "type": "string" }, { - "description": "The VLAN id to be used for Management traffic by VMware host", - "length": 255, - "name": "vlan", - "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" }, @@ -107252,24 +107778,23 @@ "type": "string" }, { - "description": "the trafficType to be added to the physical network", + "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": "traffictype", - "required": true, + "name": "isolationmethod", + "required": false, "type": "string" }, { - "description": "the Physical Network ID", + "description": "The VLAN id to be used for Management traffic by VMware host", "length": 255, - "name": "physicalnetworkid", - "related": "updatePhysicalNetwork", - "required": true, - "type": "uuid" + "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" } @@ -107277,55 +107802,55 @@ "related": "", "response": [ { - "description": "the trafficType to be added to the physical network", - "name": "traffictype", + "description": "The network name label of the physical device dedicated to this traffic on a KVM host", + "name": "kvmnetworklabel", "type": "string" }, { - "description": "the physical network this 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 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 UUID of the latest async job acting on this object", - "name": "jobid", - "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" + "description": "the trafficType to be added to the physical network", + "name": "traffictype", + "type": "string" }, { - "description": "The network name label of the physical device dedicated to this traffic on a KVM host", - "name": "kvmnetworklabel", + "description": "The network name label of the physical device dedicated to this traffic on a VMware host", + "name": "vmwarenetworklabel", "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 XenServer host", "name": "xennetworklabel", "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 label of the physical device dedicated to this traffic on a HyperV host", + "name": "hypervnetworklabel", + "type": "string" + }, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" } ], @@ -107337,24 +107862,23 @@ "name": "listSecondaryStorageSelectors", "params": [ { - "description": "The zone ID to be used in the search filter.", + "description": "Show removed heuristics.", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "showremoved", + "required": false, + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Whether to filter the selectors by type and, if so, which one. Valid options are: ISO, SNAPSHOT, TEMPLATE and VOLUME.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, @@ -107366,51 +107890,57 @@ "type": "integer" }, { - "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": "Show removed heuristics.", + "description": "The zone ID to be used in the search filter.", "length": 255, - "name": "showremoved", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "", "response": [ + {}, { - "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 heuristic rule, in JavaScript language, used to select a secondary storage to be directed.", + "name": "heuristicrule", "type": "string" }, - { - "description": "When the heuristic was created.", - "name": "created", - "type": "date" - }, { "description": "The zone which the heuristic is valid upon.", "name": "zoneid", "type": "string" }, { - "description": "ID of the heuristic.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, + { + "description": "When the heuristic was removed.", + "name": "removed", + "type": "date" + }, { "description": "Description of the heuristic.", "name": "description", "type": "string" }, { - "description": "When the heuristic was removed.", - "name": "removed", + "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" }, { @@ -107418,21 +107948,16 @@ "name": "name", "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": "ID of the heuristic.", + "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" } ], "since": "4.19.0" @@ -107443,11 +107968,11 @@ "name": "listLoadBalancerRuleInstances", "params": [ { - "description": "", + "description": "true if load balancer rule VM IP information to be included; default is false", "length": 255, - "name": "pagesize", + "name": "lbvmips", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the ID of the load balancer rule", @@ -107458,11 +107983,11 @@ "type": "uuid" }, { - "description": "true if load balancer rule VM IP information to be included; default is false", + "description": "List by keyword", "length": 255, - "name": "lbvmips", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "true if listing all virtual machines currently applied to the load balancer rule; default is true", @@ -107474,42 +107999,42 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "listLoadBalancerRuleInstances", "response": [ + { + "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 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" - }, - {} + } ] }, { @@ -107527,28 +108052,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": "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" + }, + {}, + {} ] }, { @@ -107556,20 +108081,6 @@ "isasync": true, "name": "updatePhysicalNetwork", "params": [ - { - "description": "Enabled/Disabled", - "length": 255, - "name": "state", - "required": false, - "type": "string" - }, - { - "description": "the speed for the physical network[1G/10G]", - "length": 255, - "name": "networkspeed", - "required": false, - "type": "string" - }, { "description": "the VLAN for the physical network", "length": 255, @@ -107591,310 +108102,216 @@ "name": "tags", "required": false, "type": "list" - } - ], - "related": "", - "response": [ - { - "description": "comma separated tag", - "name": "tags", - "type": "string" - }, - {}, - { - "description": "Broadcast domain range of the physical network", - "name": "broadcastdomainrange", - "type": "string" - }, - { - "description": "zone name of the physical network", - "name": "zonename", - "type": "string" - }, - { - "description": "the vlan of the physical network", - "name": "vlan", - "type": "string" }, { - "description": "isolation methods", - "name": "isolationmethods", + "description": "the speed for the physical network[1G/10G]", + "length": 255, + "name": "networkspeed", + "required": false, "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "state of the physical network", + "description": "Enabled/Disabled", + "length": 255, "name": "state", + "required": false, "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "the speed of the physical network", "name": "networkspeed", "type": "string" }, - { - "description": "the uuid of the physical network", - "name": "id", - "type": "string" - }, - { - "description": "name of the physical network", - "name": "name", - "type": "string" - }, - { - "description": "the domain id of the physical network owner", - "name": "domainid", - "type": "string" - }, + {}, {}, { "description": "zone id of the physical network", "name": "zoneid", "type": "string" - } - ], - "since": "3.0.0" - }, - { - "description": "Stop a Shared FileSystem", - "isasync": true, - "name": "stopSharedFileSystem", - "params": [ - { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "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": "name of the shared filesystem", + "description": "name of the physical network", "name": "name", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "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": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "Network ID of the shared filesystem", - "name": "networkid", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "Broadcast domain range of the physical network", + "name": "broadcastdomainrange", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the uuid of the physical network", + "name": "id", "type": "string" }, { - "description": "the account associated with the shared filesystem", - "name": "account", + "description": "zone name of the physical network", + "name": "zonename", "type": "string" }, { - "description": "size of the shared filesystem", - "name": "size", - "type": "long" - }, - {}, - { - "description": "the state of the shared filesystem", + "description": "state of the physical network", "name": "state", "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": "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": "the domain id of the physical network owner", + "name": "domainid", + "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "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": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the vlan of the physical network", + "name": "vlan", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "comma separated tag", + "name": "tags", + "type": "string" + }, + { + "description": "isolation methods", + "name": "isolationmethods", "type": "string" + } + ], + "since": "3.0.0" + }, + { + "description": "Stop a Shared FileSystem", + "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, + "name": "id", + "related": "listSharedFileSystems,stopSharedFileSystem,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "required": true, + "type": "uuid" + } + ], + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "response": [ { "description": "the project name of the shared filesystem", "name": "project", "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "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": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "Name of the availability zone", + "name": "zonename", + "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "path to mount the shared filesystem", + "name": "path", "type": "string" }, + {}, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", - "type": "long" + "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 project ID of the shared filesystem", + "name": "projectid", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "type": "string" + }, + { + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" + }, { "description": "disk offering for the shared filesystem", "name": "diskofferingname", "type": "string" }, { - "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 in GiB", - "name": "sizegb", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "the account associated with the shared filesystem", + "name": "account", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { @@ -107902,68 +108319,78 @@ "name": "domainpath", "type": "string" }, + { + "description": "size of the shared filesystem", + "name": "size", + "type": "long" + }, { "description": "the list of nics associated with the shared filesystem", "name": "nic", "response": [ + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, { "description": "the gateway of the nic", "name": "gateway", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "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 isolation uri of the nic", - "name": "isolationuri", + "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", + "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": "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", - "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" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -107972,23 +108399,23 @@ "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -107997,65 +108424,60 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 gateway of IPv6 network", + "name": "ip6gateway", + "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": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the nic", + "name": "id", "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": "the cidr of IPv6 network", "name": "ip6cidr", "type": "string" }, - { - "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": "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, { "description": "the name of the corresponding network", "name": "networkname", @@ -108065,23 +108487,38 @@ "type": "list" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "ID of the availability zone", + "name": "zoneid", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", + "type": "string" + }, + { + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { @@ -108090,39 +108527,127 @@ "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + {}, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", + "type": "string" + }, + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { "description": "ID of the storage fs data volume", "name": "volumeid", "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" } ], "since": "4.20.0" @@ -108133,33 +108658,32 @@ "name": "createVgpuProfile", "params": [ { - "description": "the name of the vGPU profile", + "description": "the maximum Y resolution", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "maxresolutiony", + "required": false, + "type": "long" }, { - "description": "the GPU card ID associated with this GPU device", + "description": "the name of the vGPU profile", "length": 255, - "name": "gpucardid", - "related": "", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "the maximum Y resolution", + "description": "the description of the vGPU profile", "length": 255, - "name": "maxresolutiony", + "name": "description", "required": false, - "type": "long" + "type": "string" }, { - "description": "the description of the vGPU profile", + "description": "Max vGPU per physical GPU. This is used to calculate capacity.", "length": 255, - "name": "description", + "name": "maxvgpuperphysicalgpu", "required": false, - "type": "string" + "type": "long" }, { "description": "the maximum X resolution", @@ -108176,68 +108700,52 @@ "type": "long" }, { - "description": "the maximum number of display heads", + "description": "the GPU card ID associated with this GPU device", "length": 255, - "name": "maxheads", - "required": false, - "type": "long" + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "Max vGPU per physical GPU. This is used to calculate capacity.", + "description": "the maximum number of display heads", "length": 255, - "name": "maxvgpuperphysicalgpu", + "name": "maxheads", "required": false, "type": "long" } ], "related": "", "response": [ - { - "description": "the ID of the GPU card associated with this vGPU profile", - "name": "gpucardid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the vendor name of the GPU card", - "name": "vendorname", - "type": "string" - }, - {}, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, { "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 name of the vGPU profile", + "name": "gpucardname", + "type": "string" }, { - "description": "the ID of the GPU card", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { "description": "the device ID of the GPU card", "name": "deviceid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "the ID of the GPU card associated with this vGPU profile", + "name": "gpucardid", + "type": "string" + }, + { + "description": "the vendor ID of the GPU card", + "name": "vendorid", + "type": "string" }, { "description": "the display name of the GPU card", @@ -108245,13 +108753,18 @@ "type": "string" }, { - "description": "the name of the vGPU profile", - "name": "gpucardname", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "the vendor ID of the GPU card", - "name": "vendorid", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "the description of the vGPU profile", + "name": "description", "type": "string" }, { @@ -108259,21 +108772,33 @@ "name": "maxvgpuperphysicalgpu", "type": "long" }, + { + "description": "the ID of the GPU card", + "name": "id", + "type": "string" + }, { "description": "the device name of the GPU card", "name": "devicename", "type": "string" }, { - "description": "the description of the vGPU profile", - "name": "description", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the vendor name of the GPU card", + "name": "vendorname", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" - } + }, + {}, + {} ], "since": "4.21.0" }, @@ -108292,28 +108817,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": "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" + } ] }, { @@ -108329,26 +108854,19 @@ "type": "integer" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "the uuid of Tungsten-Fabric firewall policy", + "description": "the uuid of Tungsten-Fabric firewall rule", "length": 255, - "name": "firewallpolicyuuid", + "name": "firewallruleuuid", "required": false, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric firewall rule", + "description": "the ID of zone", "length": 255, - "name": "firewallruleuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -108363,23 +108881,25 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the uuid of Tungsten-Fabric firewall policy", + "length": 255, + "name": "firewallpolicyuuid", + "required": false, + "type": "string" } ], "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", + "description": "Tungsten-Fabric firewall rule source tag", + "name": "srctag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule direction", - "name": "direction", + "description": "Tungsten-Fabric firewall rule action", + "name": "action", "type": "string" }, { @@ -108387,7 +108907,22 @@ "name": "destnetwork", "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 service group", + "name": "servicegroup", + "type": "string" + }, { "description": "Tungsten-Fabric firewall rule name", "name": "name", @@ -108399,23 +108934,13 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "Tungsten-Fabric firewall rule destination tag", - "name": "desttag", - "type": "string" - }, - { - "description": "Tungsten-Fabric firewall rule service group", - "name": "servicegroup", + "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 source network", + "name": "srcnetwork", "type": "string" }, { @@ -108424,28 +108949,28 @@ "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 source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric firewall rule destination tag", + "name": "desttag", "type": "string" }, { - "description": "Tungsten-Fabric firewall rule action", - "name": "action", + "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": "Tungsten-Fabric firewall rule destination address group", - "name": "destaddressgroup", + "description": "Tungsten-Fabric firewall rule uuid", + "name": "uuid", "type": "string" }, {} @@ -108457,25 +108982,25 @@ "name": "listNetrisProviders", "params": [ { - "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "ID of the zone", @@ -108489,28 +109014,28 @@ "related": "deleteNetrisProvider", "response": [ { - "description": "Netris provider uuid", - "name": "uuid", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, { - "description": "Zone ID to which the Netris Provider is associated with", - "name": "zoneid", + "description": "Netris Provider site", + "name": "sitename", "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", + "description": "Netris Provider URL", + "name": "netrisurl", + "type": "string" + }, + { + "description": "Zone ID to which the Netris Provider is associated with", + "name": "zoneid", "type": "string" }, { @@ -108518,27 +109043,27 @@ "name": "jobid", "type": "string" }, + {}, { "description": "Netris Tag for vNets", "name": "netristag", "type": "string" }, + {}, { - "description": "Netris Provider site", - "name": "sitename", + "description": "Netris provider uuid", + "name": "uuid", "type": "string" }, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Provider name", + "name": "name", "type": "string" }, - {}, - {}, { - "description": "Netris Provider URL", - "name": "netrisurl", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.21.0" @@ -108564,13 +109089,6 @@ "since": "4.15.0", "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, @@ -108587,6 +109105,13 @@ "required": false, "type": "uuid" }, + { + "description": "The display text of the project, defaults to the 'name´.", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "name of the project", "length": 255, @@ -108598,8 +109123,13 @@ "related": "", "response": [ { - "description": "the total memory (in MB) available to be created for this project", - "name": "memoryavailable", + "description": "the total number of vpcs owned by project", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the total object storage space (in GiB) the project can own", + "name": "objectstoragelimit", "type": "string" }, { @@ -108608,131 +109138,92 @@ "type": "long" }, { - "description": "the total number of snapshots available for this project", - "name": "snapshotavailable", + "description": "the name of the project", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of buckets which can be stored by this project", + "name": "bucketlimit", "type": "string" }, { - "description": "the total memory (in MB) owned by project", - "name": "memorytotal", - "type": "long" + "description": "the total memory (in MB) the project can own", + "name": "memorylimit", + "type": "string" }, { - "description": "the total number of buckets stored by this project", - "name": "buckettotal", + "description": "the total volume being used by this project", + "name": "volumetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the project can own", - "name": "objectstoragelimit", + "description": "the id of the project", + "name": "id", "type": "string" }, { - "description": "the total number of vpcs owned by project", - "name": "vpctotal", - "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 stored by this project", - "name": "snapshottotal", + "description": "the total number of gpus owned by project", + "name": "gputotal", "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 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", - "type": "string" + "description": "the total number of virtual machines running for this project", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of virtual machines that can be deployed by this project", - "name": "vmlimit", + "description": "the domain id the project belongs to", + "name": "domainid", "type": "string" }, { - "description": "the total number of snapshots which can be stored by this project", - "name": "snapshotlimit", + "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 project", - "name": "templateavailable", - "type": "string" + "description": "the total number of buckets stored by this project", + "name": "buckettotal", + "type": "long" }, { - "description": "the total number of cpu cores the project can own", - "name": "cpulimit", + "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", - "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", + "description": "the state of the project", + "name": "state", "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", + "description": "the total number of gpus available to be created for this project", + "name": "gpuavailable", "type": "string" }, - {}, { "description": "the total number of virtual machines stopped for this project", "name": "vmstopped", @@ -108744,107 +109235,47 @@ "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", + "description": "the total number of buckets available to this project", + "name": "bucketavailable", "type": "string" }, { - "description": "the account name of the project's owners", - "name": "owner", - "type": "list" - }, - { - "description": "the total primary storage space (in GiB) the project can own", - "name": "primarystoragelimit", + "description": "the total number of virtual machines that can be deployed by this project", + "name": "vmlimit", "type": "string" }, { - "description": "the total volume which can be used by this project", - "name": "volumelimit", + "description": "the total number of snapshots which can be stored by this project", + "name": "snapshotlimit", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the project account name of the project", - "name": "projectaccountname", + "description": "the total number of backups which can be stored by this project", + "name": "backuplimit", "type": "string" }, { - "description": "the total number of backups stored by this project", - "name": "backuptotal", + "description": "the total memory (in MB) owned by project", + "name": "memorytotal", "type": "long" }, - { - "description": "The tagged resource limit and count for the project", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the domain name where the project belongs to", - "name": "domain", - "type": "string" - }, - { - "description": "the total volume available for this project", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of gpus the project can own", - "name": "gpulimit", - "type": "string" - }, { "description": "the list of resource tags associated with vm", "name": "tags", "response": [ - { - "description": "id of the resource", - "name": "resourceid", - "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -108853,8 +109284,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" }, { @@ -108863,8 +109294,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -108873,48 +109304,132 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the total secondary storage space (in GiB) available to be used for this project", - "name": "secondarystorageavailable", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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) available to be used for this project", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the displaytext of the project", + "name": "displaytext", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this project", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the total number of snapshots stored by this project", + "name": "snapshottotal", + "type": "long" + }, + { + "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 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 total backup storage space (in GiB) the project can own", + "name": "backupstoragelimit", + "type": "string" + }, + { + "description": "the total number of networks owned by project", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of cpu cores the project can own", + "name": "cpulimit", + "type": "string" + }, + { + "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) owned by the project", + "name": "backupstoragetotal", + "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 deployed by this project", - "name": "vmtotal", - "type": "long" + "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) owned by project", - "name": "primarystoragetotal", - "type": "long" + "description": "the total number of backups available to this project", + "name": "backupavailable", + "type": "string" }, { - "description": "the total number of buckets which can be stored by this project", - "name": "bucketlimit", + "description": "the total number of cpu cores available to be created for this project", + "name": "cpuavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this project", - "name": "templatetotal", - "type": "long" + "description": "the account name of the project's owners", + "name": "owner", + "type": "list" }, { - "description": "the name of the project", - "name": "name", + "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 backups stored by this project", + "name": "backuptotal", + "type": "long" }, { "description": "the total object storage space (in GiB) available to the project", @@ -108922,14 +109437,24 @@ "type": "string" }, { - "description": "the total number of gpus owned by project", - "name": "gputotal", + "description": "the total number of networks the project can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total backup storage space (in GiB) available to the project", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this project", + "name": "iptotal", "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 vpcs the project can own", @@ -108937,43 +109462,43 @@ "type": "string" }, { - "description": "the state of the project", - "name": "state", + "description": "the total number of gpus the project can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this project", - "name": "vpcavailable", + "description": "the total primary storage space (in GiB) the project can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of backups available to this project", - "name": "backupavailable", - "type": "string" + "description": "the total object storage space (in GiB) owned by the project", + "name": "objectstoragetotal", + "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 backup storage space (in GiB) available to the project", - "name": "backupstorageavailable", + "description": "the total volume available for this project", + "name": "volumeavailable", "type": "string" }, { - "description": "the displaytext of the project", - "name": "displaytext", + "description": "the total number of snapshots available for this project", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this project", - "name": "gpuavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by project", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of networks the project can own", - "name": "networklimit", + "description": "the project account name of the project", + "name": "projectaccountname", "type": "string" } ], @@ -108985,29 +109510,43 @@ "name": "assignCertToLoadBalancer", "params": [ { - "description": "the ID of the certificate", + "description": "the ID of the load balancer rule", "length": 255, - "name": "certid", - "related": "", + "name": "lbruleid", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "Force assign the certificate. If there is a certificate assigned to the LB, it will be removed at first.", "length": 255, - "name": "lbruleid", - "related": "createPortForwardingRule,updatePortForwardingRule", + "name": "forced", + "required": false, + "since": "4.22", + "type": "boolean" + }, + { + "description": "the ID of the certificate", + "length": 255, + "name": "certid", + "related": "", "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", + "type": "string" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -109017,12 +109556,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" } ] }, @@ -109031,6 +109564,13 @@ "isasync": false, "name": "addCiscoVnmcResource", "params": [ + { + "description": "Credentials to access the Cisco VNMC Controller API", + "length": 255, + "name": "username", + "required": true, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -109046,13 +109586,6 @@ "required": true, "type": "string" }, - { - "description": "Credentials to access the Cisco VNMC Controller API", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "Credentials to access the Cisco VNMC Controller API", "length": 255, @@ -109063,14 +109596,6 @@ ], "related": "listCiscoVnmcResources", "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - {}, - {}, - {}, {}, {}, {}, @@ -109079,6 +109604,14 @@ "name": "jobstatus", "type": "integer" }, + {}, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {} ] }, @@ -109087,14 +109620,6 @@ "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, @@ -109103,6 +109628,14 @@ "required": true, "type": "string" }, + { + "description": "The Zone ID with which the account is to be marked.", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, { "description": "Marks the account that belongs to the specified domain.", "length": 255, @@ -109114,9 +109647,20 @@ ], "related": "disableAccount,enableAccount,updateAccount,listAccounts", "response": [ + {}, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the name of the account", + "name": "name", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { @@ -109125,28 +109669,88 @@ "type": "resourceiconresponse" }, { - "description": "the total number of networks owned by account", - "name": "networktotal", + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "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 total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" }, { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" + }, + { + "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" + }, + { + "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": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, { @@ -109154,40 +109758,114 @@ "name": "snapshotavailable", "type": "string" }, - {}, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" + }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", + "type": "string" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, + { + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" + }, { "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", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "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": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "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" }, { @@ -109196,18 +109874,33 @@ "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "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", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total number of networks owned by account", + "name": "networktotal", + "type": "long" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { @@ -109215,40 +109908,54 @@ "name": "created", "type": "date" }, - {}, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "the default zone of the account", + "name": "defaultzoneid", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "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", - "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) the account can own", - "name": "memorylimit", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", "type": "string" }, { @@ -109256,9 +109963,9 @@ "name": "user", "response": [ { - "description": "the user email address", - "name": "email", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "the account ID of the user", @@ -109266,33 +109973,23 @@ "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", + "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 ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the api key of the user", + "name": "apikey", "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" }, { @@ -109301,19 +109998,14 @@ "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", - "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)", @@ -109326,15 +110018,35 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the timezone user was created in", + "name": "timezone", + "type": "string" }, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, + { + "description": "the user email address", + "name": "email", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the user state", + "name": "state", + "type": "string" + }, { "description": "the type of the role", "name": "roletype", @@ -109345,122 +110057,62 @@ "name": "username", "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 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 name of the role", - "name": "rolename", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the account name of the user", + "name": "account", + "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "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" } ], "type": "list" }, { - "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 primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "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", + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { - "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", + "description": "the total object storage space (in GiB) owned by the account", + "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 role", - "name": "roleid", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", - "type": "string" - }, - { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", - "type": "string" - }, - { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { @@ -109469,63 +110121,23 @@ "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" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "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", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "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" + "description": "the total number of virtual machines running for this account", + "name": "vmrunning", + "type": "integer" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { @@ -109533,132 +110145,66 @@ "name": "volumeavailable", "type": "string" }, - { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", - "type": "string" - }, - { - "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": "the name of the role", - "name": "rolename", - "type": "string" - }, - { - "description": "the total volume which can be used by this account", - "name": "volumelimit", - "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) 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", + "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 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", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" } ], "since": "4.0" }, { - "description": "Deletes a routing firewall rule", + "description": "Revokes certificate using configured CA plugin", "isasync": true, - "name": "deleteRoutingFirewallRule", + "name": "revokeCertificate", "params": [ { - "description": "the ID of the Routing firewall rule", + "description": "The certificate serial number, as a hex value", "length": 255, - "name": "id", - "related": "createPortForwardingRule,updatePortForwardingRule", + "name": "serial", "required": true, - "type": "uuid" + "type": "string" + }, + { + "description": "The certificate CN", + "length": 255, + "name": "cn", + "required": false, + "type": "string" + }, + { + "description": "Name of the CA service provider, otherwise the default configured provider plugin will be used", + "length": 255, + "name": "provider", + "required": false, + "type": "string" } ], "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" }, { @@ -109674,60 +110220,47 @@ }, {} ], - "since": "4.20.0" + "since": "4.11.0" }, { - "description": "Revokes certificate using configured CA plugin", + "description": "Deletes a routing firewall rule", "isasync": true, - "name": "revokeCertificate", + "name": "deleteRoutingFirewallRule", "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", + "description": "the ID of the Routing firewall rule", "length": 255, - "name": "serial", + "name": "id", + "related": "createPortForwardingRule,updatePortForwardingRule", "required": true, - "type": "string" - }, - { - "description": "The certificate CN", - "length": 255, - "name": "cn", - "required": false, - "type": "string" + "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": "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.11.0" + "since": "4.20.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.", @@ -109761,151 +110294,150 @@ "related": "startSystemVm", "response": [ { - "description": "the ID of the system VM", - "name": "id", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the ID of the system VM", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the systemvm agent version", - "name": "version", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, - {}, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the number of active console sessions for the console proxy system vm", - "name": "activeviewersessions", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the name of the system VM", - "name": "name", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, { - "description": "the first DNS for the system VM", - "name": "dns1", + "description": "the Pod name for the system VM", + "name": "podname", "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 private netmask for the system VM", - "name": "privatenetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "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", + "description": "the name of the system VM", + "name": "name", "type": "string" }, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "CPU arch of the system VM", + "name": "arch", "type": "string" }, - {}, { - "description": "the date and time the system VM was created", - "name": "created", - "type": "date" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", - "type": "string" + "description": "the last disconnected date of host", + "name": "disconnected", + "type": "date" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the network domain for the system VM", + "name": "networkdomain", + "type": "string" }, { "description": "the host ID for the system VM", @@ -109913,58 +110445,59 @@ "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", - "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 gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", - "type": "string" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the link local IP address for the system vm", - "name": "linklocalip", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "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 systemvm agent version", + "name": "version", + "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the private IP address for the system VM", + "name": "privateip", "type": "string" } ] @@ -109974,6 +110507,21 @@ "isasync": false, "name": "updateSiocInfo", "params": [ + { + "description": "Limit IOPS per GB", + "length": 255, + "name": "limitiopspergb", + "required": true, + "type": "integer" + }, + { + "description": "Storage Pool ID", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": true, + "type": "uuid" + }, { "description": "Zone ID", "length": 255, @@ -109995,23 +110543,35 @@ "name": "sharespergb", "required": true, "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Limit IOPS per GB", - "length": 255, - "name": "limitiopspergb", - "required": true, - "type": "integer" + "description": "The return message from the operation ('Success' if successful)", + "name": "msg", + "type": "string" }, { - "description": "Storage Pool ID", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": true, - "type": "uuid" - } + "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": "", "response": [ {}, @@ -110022,8 +110582,8 @@ }, {}, { - "description": "The return message from the operation ('Success' if successful)", - "name": "msg", + "description": "the sso redirect url", + "name": "url", "type": "string" }, { @@ -110049,27 +110609,27 @@ } ], "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": "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" + }, + { + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" } ], "since": "4.2.0" @@ -110087,13 +110647,6 @@ "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, @@ -110103,48 +110656,47 @@ "type": "uuid" }, { - "description": "The ID of the virtual machine.", + "description": "IP address of the creator of the console endpoint.", "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", + "name": "consoleendpointcreatoraddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "Lists console sessions from the specified host.", + "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": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "The ID of the virtual machine.", "length": 255, - "name": "page", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "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.", + "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": "isrecursive", + "name": "startdate", "required": false, - "type": "boolean" + "type": "date" }, { - "description": "Lists only active console sessions, defaults to true. Active sessions are the ones that have been acquired and have not been removed.", + "description": "", "length": 255, - "name": "activeonly", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "The ID of the console session.", @@ -110155,69 +110707,77 @@ "type": "uuid" }, { - "description": "IP address of the client that accessed the console session.", + "description": "", "length": 255, - "name": "clientaddress", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "The ID of the account that created the console endpoint.", "length": 255, - "name": "keyword", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, - "type": "string" + "type": "uuid" }, { - "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.", + "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": "startdate", + "name": "activeonly", "required": false, - "type": "date" + "type": "boolean" }, { - "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.", + "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": "enddate", + "name": "acquired", "required": false, - "type": "date" + "type": "boolean" }, { - "description": "The ID of the account that created the console endpoint.", + "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": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "isrecursive", + "required": false, + "type": "boolean" + }, + { + "description": "Lists console sessions from the specified host.", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "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.", + "description": "IP address of the client that accessed the console session.", "length": 255, - "name": "acquired", + "name": "clientaddress", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "ID of the account that created the console endpoint.", - "name": "accountid", + "description": "ID of the host.", + "name": "hostid", "type": "string" }, { - "description": "Domain of the account that created the console endpoint.", - "name": "domain", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Domain ID of the account that created the console endpoint.", - "name": "domainid", + "description": "ID of the account that created the console endpoint.", + "name": "accountid", "type": "string" }, { - "description": "Domain path of the account that created the console endpoint.", - "name": "domainpath", + "description": "Name of the virtual machine.", + "name": "virtualmachinename", "type": "string" }, { @@ -110226,29 +110786,13 @@ "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", + "description": "Domain ID of the account that created the console endpoint.", + "name": "domainid", "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", + "description": "Name of the host.", + "name": "hostname", "type": "string" }, { @@ -110262,40 +110806,56 @@ "type": "string" }, { - "description": "Name of the virtual machine.", - "name": "virtualmachinename", + "description": "Date when the console session was acquired.", + "name": "acquired", + "type": "date" + }, + { + "description": "IP address of the creator of the console endpoint.", + "name": "consoleendpointcreatoraddress", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "ID of the user that created the console endpoint.", + "name": "userid", + "type": "string" }, { - "description": "ID of the host.", - "name": "hostid", + "description": "ID of the virtual machine.", + "name": "virtualmachineid", "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", + "description": "Date when the console session's endpoint was created.", + "name": "created", + "type": "date" + }, + { + "description": "Domain of the account that created the console endpoint.", + "name": "domain", "type": "string" }, + {}, { - "description": "Name of the host.", - "name": "hostname", + "description": "Domain path of the account that created the console endpoint.", + "name": "domainpath", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" + }, + { + "description": "Date when the console session was removed.", + "name": "removed", + "type": "date" } ], "since": "4.21.0" @@ -110305,39 +110865,61 @@ "isasync": true, "name": "unmanageVirtualMachine", "params": [ + { + "description": "Force unmanaging Instance with config drive. Applicable only for KVM Hypervisor.", + "length": 255, + "name": "forced", + "required": false, + "since": "4.22.0", + "type": "boolean" + }, + { + "description": "ID of the host which will be used for unmanaging the Instance. Applicable only for KVM hypervisor and stopped Instances. Domain XML will be stored on this host.", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": false, + "since": "4.22.0", + "type": "uuid" + }, { "description": "The ID of the virtual machine to unmanage", "length": 255, "name": "id", - "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", + "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,createVMFromBackup,importVm", "required": true, "type": "uuid" } ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "details of the unmanage VM operation", "name": "details", "type": "string" }, - {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "result of the unmanage VM operation", "name": "success", "type": "boolean" }, - {}, + { + "description": "The ID of the host used for unmanaged Instance", + "name": "hostid", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - } + }, + {}, + {} ], "since": "4.15.0" }, @@ -110346,14 +110928,6 @@ "isasync": true, "name": "rebootRouter", "params": [ - { - "description": "the ID of the router", - "length": 255, - "name": "id", - "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", - "required": true, - "type": "uuid" - }, { "description": "Force reboot the router (Router is force Stopped and then Started)", "length": 255, @@ -110361,91 +110935,62 @@ "required": false, "since": "4.16.0", "type": "boolean" + }, + { + "description": "the ID of the router", + "length": 255, + "name": "id", + "related": "listRouters,rebootRouter,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", + "required": true, + "type": "uuid" } ], "related": "listRouters,changeServiceForRouter,stopInternalLoadBalancerVM,listInternalLoadBalancerVMs", "response": [ { - "description": "the Zone ID for the router", - "name": "zoneid", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the version of template", - "name": "version", + "description": "the control state of the host for the router", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { "description": "true if the router template requires upgrader", @@ -110453,29 +110998,197 @@ "type": "boolean" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" + }, + { + "description": "the list of nics associated with the router", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "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": "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": "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 IPv6 address of network", + "name": "ip6address", + "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", + "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 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": "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": "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 traffic type of the nic", + "name": "traffictype", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" + } + ], + "type": "set" + }, + { + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, + {}, { - "description": "the name of the router", - "name": "name", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, {}, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { @@ -110484,23 +111197,50 @@ "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" - }, - { - "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 result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + }, + { + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" + }, + { + "description": "result of the health check if available", + "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 name of the health check on the router", + "name": "checkname", + "type": "string" + } + ], + "type": "list" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { @@ -110509,59 +111249,58 @@ "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the router", + "name": "name", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the first DNS for the router", + "name": "dns1", "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": "the Pod ID for the router", - "name": "podid", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { @@ -110570,63 +111309,58 @@ "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "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", + "description": "the version of template", + "name": "version", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "the gateway for the router", - "name": "gateway", + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the guest IP address for the router", + "name": "guestipaddress", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "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", + "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", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { @@ -110635,18 +111369,23 @@ "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": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the hostname for the router", + "name": "hostname", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { @@ -110655,185 +111394,33 @@ "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the list of nics associated with the router", - "name": "nic", - "response": [ - { - "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": "true if nic is default, false otherwise", - "name": "macaddress", - "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 gateway of the nic", - "name": "gateway", - "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "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 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 VLAN/VNI if available", - "name": "vlanid", - "type": "integer" - }, - { - "description": "the ID of the corresponding network", - "name": "networkid", - "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", - "type": "string" - }, - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the traffic type of the nic", - "name": "traffictype", - "type": "string" - }, - { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "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": "Type of adapter if available", - "name": "adaptertype", - "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", - "type": "string" - } - ], - "type": "set" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "the public MAC address for the router", + "name": "publicmacaddress", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" } ] @@ -110844,20 +111431,26 @@ "name": "listNics", "params": [ { - "description": "list nic of the specific vm's network", + "description": "", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the nic to list IPs", "length": 255, @@ -110867,11 +111460,11 @@ "type": "uuid" }, { - "description": "the ID of the vm", + "description": "list nic of the specific vm's network", "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, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, "type": "uuid" }, { @@ -110883,18 +111476,12 @@ "type": "boolean" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "List by keyword", + "description": "the ID of the vm", "length": 255, - "name": "keyword", - "required": false, - "type": "string" + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" } ], "related": "", @@ -110904,102 +111491,106 @@ "name": "ipaddress", "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "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": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "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": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "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": "true if nic is default, false otherwise", - "name": "macaddress", + "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 corresponding network", + "name": "networkid", "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, + {}, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the type of the nic", + "name": "type", "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": "public IP address associated with this nic via Static nat rule", @@ -111007,63 +111598,59 @@ "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "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": "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": "the ID of the nic", - "name": "id", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", + "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", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "public IP address id associated with this nic via Static nat rule", + "name": "publicipid", "type": "string" } ] @@ -111073,13 +111660,6 @@ "isasync": false, "name": "listCniConfiguration", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, @@ -111096,26 +111676,25 @@ "type": "uuid" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "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": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ID of the Userdata", + "description": "", "length": 255, - "name": "id", - "related": "listCniConfiguration", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "list only resources belonging to the domain specified", @@ -111126,90 +111705,92 @@ "type": "uuid" }, { - "description": "Userdata name to look for", + "description": "the ID of the Userdata", "length": 255, - "name": "name", + "name": "id", + "related": "listCniConfiguration", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "Userdata name to look for", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "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" } ], "related": "", "response": [ { - "description": "ID of the User Data", - "name": "id", - "type": "string" - }, - { - "description": "the owner id of the User Data", - "name": "accountid", + "description": "path of the domain to which the User Data owner belongs", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain id of the User Data owner", - "name": "domainid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the project name of the User Data", - "name": "project", + "description": "the owner of the User Data", + "name": "account", "type": "string" }, { - "description": "the domain name of the User Data owner", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "base64 encoded User Data content", - "name": "userdata", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the owner of the User Data", - "name": "account", + "description": "the domain id of the User Data owner", + "name": "domainid", "type": "string" }, + {}, { "description": "Name of the User Data", "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "ID of the User Data", + "name": "id", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the owner id of the User Data", + "name": "accountid", + "type": "string" }, - {}, { - "description": "the project id of the User Data", - "name": "projectid", + "description": "the project name of the User Data", + "name": "project", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the domain name of the User Data owner", + "name": "domain", + "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 the User Data", @@ -111217,10 +111798,16 @@ "type": "string" }, { - "description": "path of the domain to which the User Data owner belongs", - "name": "domainpath", + "description": "base64 encoded User Data content", + "name": "userdata", "type": "string" - } + }, + { + "description": "the project id of the User Data", + "name": "projectid", + "type": "string" + }, + {} ], "since": "4.21.0" }, @@ -111230,32 +111817,38 @@ "name": "listBgpPeers", "params": [ { - "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", + "description": "AS number of the Bgp Peer.", "length": 255, - "name": "account", + "name": "asnumber", "required": false, - "type": "string" + "type": "long" }, { - "description": "the domain ID which the Bgp Peer is dedicated to.", + "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": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "isdedicated", "required": false, - "type": "uuid" + "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": "List by keyword", "length": 255, - "name": "isdedicated", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "project who which the Bgp Peer is dedicated to", + "description": "the account which the Bgp Peer is dedicated to. Must be used with the domainId parameter.", "length": 255, - "name": "projectid", - "related": "", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "UUID of the Bgp Peer.", + "length": 255, + "name": "id", + "related": "listBgpPeers,releaseBgpPeer", "required": false, "type": "uuid" }, @@ -111267,68 +111860,74 @@ "type": "integer" }, { - "description": "AS number of the Bgp Peer.", + "description": "", "length": 255, - "name": "asnumber", + "name": "pagesize", "required": false, - "type": "long" + "type": "integer" }, { - "description": "UUID of zone to which the Bgp Peer belongs to.", + "description": "project who which the Bgp Peer is dedicated to", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "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", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "UUID of zone to which the Bgp Peer belongs to.", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "releaseBgpPeer", "response": [ { - "description": "id of the bgp peer", - "name": "id", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, + {}, { "description": "the project id of the bgp peer", "name": "projectid", "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" + }, + { + "description": "password of bgp peer", + "name": "password", "type": "string" }, { - "description": "name of zone to which the bgp peer belongs to.", - "name": "zonename", + "description": "the domain name of the bgp peer", + "name": "domain", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" + }, + {}, + { + "description": "IPv6 address of bgp peer", + "name": "ip6address", "type": "string" }, { @@ -111341,52 +111940,40 @@ "name": "project", "type": "string" }, - { - "description": "IPv6 address of bgp peer", - "name": "ip6address", - "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": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "id of the bgp peer", + "name": "id", "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": "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": "date when this bgp peer was created.", - "name": "created", - "type": "date" + "description": "the domain ID of the bgp peer", + "name": "domainid", + "type": "string" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.20.0" @@ -111396,6 +111983,14 @@ "isasync": true, "name": "createSnapshotFromVMSnapshot", "params": [ + { + "description": "The ID of the disk volume", + "length": 255, + "name": "volumeid", + "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", + "required": true, + "type": "uuid" + }, { "description": "The ID of the VM snapshot", "length": 255, @@ -111410,21 +112005,13 @@ "name": "name", "required": false, "type": "string" - }, - { - "description": "The ID of the disk volume", - "length": 255, - "name": "volumeid", - "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,assignVolume,importVolume", - "required": true, - "type": "uuid" } ], "related": "copySnapshot,archiveSnapshot,listSnapshots", "response": [ { - "description": "ID of the snapshot", - "name": "id", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { @@ -111432,103 +112019,89 @@ "name": "datastoretype", "type": "string" }, - { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" - }, { "description": "the project name of the snapshot", "name": "project", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", - "type": "string" - }, - { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "name of the disk volume", - "name": "volumename", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "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": "ID of the datastore for the snapshot entry", - "name": "datastoreid", - "type": "string" + "description": " the date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the account associated with the snapshot", - "name": "account", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "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": "virtual size of backedup snapshot on image store", - "name": "virtualsize", - "type": "long" - }, - { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "state of the disk volume", + "name": "volumestate", "type": "string" }, + {}, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "name of the snapshot", + "name": "name", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "the domain ID of the snapshot's account", + "name": "domainid", "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 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": "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" }, { @@ -111537,8 +112110,13 @@ "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", "type": "string" }, { @@ -111552,110 +112130,119 @@ "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", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "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 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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project id of the snapshot", + "name": "projectid", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "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 snapshot on the datastore", + "name": "datastorestate", + "type": "string" }, - {}, { "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", "name": "revertable", "type": "boolean" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the os on volume", + "name": "ostypeid", "type": "string" }, { - "description": "type of the disk volume", - "name": "volumetype", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { - "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": "id of the os on volume", - "name": "ostypeid", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "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 date the snapshot was created", - "name": "created", - "type": "date" + "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 availability zone", + "name": "zonename", + "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "name of the disk volume", + "name": "volumename", "type": "string" - } + }, + {} ], "since": "4.10.0" }, @@ -111704,23 +112291,23 @@ "related": "", "response": [ { - "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", + "description": "Name of the data store object.", + "name": "name", "type": "string" }, { - "description": "Volume Name associated with the data store object.", - "name": "volumename", + "description": "Format of template associated with the data store object.", + "name": "format", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Snapshot Name associated with the data store object.", + "name": "snapshotname", "type": "string" }, { @@ -111729,19 +112316,19 @@ "type": "integer" }, { - "description": "Name of the data store object.", - "name": "name", - "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", + "type": "string" }, {}, { - "description": "Template Name associated with the data store object.", - "name": "templatename", + "description": "Volume ID associated with the data store object.", + "name": "volumeid", "type": "string" }, { @@ -111749,26 +112336,26 @@ "name": "templateid", "type": "string" }, - {}, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "Snapshot ID associated with the data store object.", - "name": "snapshotid", + "description": "Volume Name associated with the data store object.", + "name": "volumename", "type": "string" }, { - "description": "Last modified date of the file/directory.", - "name": "lastupdated", - "type": "date" + "description": "Template Name associated with the data store object.", + "name": "templatename", + "type": "string" } ], "since": "4.19.0" @@ -111779,12 +112366,11 @@ "name": "dedicateGuestVlanRange", "params": [ { - "description": "domain ID of the account owning a VLAN", + "description": "account who will own the VLAN", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { "description": "project who will own the VLAN", @@ -111795,11 +112381,12 @@ "type": "uuid" }, { - "description": "account who will own the VLAN", + "description": "physical network ID of the vlan", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "guest vlan range to be dedicated", @@ -111809,57 +112396,47 @@ "type": "string" }, { - "description": "physical network ID of the vlan", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, "type": "uuid" } ], "related": "", "response": [ - {}, { "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", - "name": "jobstatus", - "type": "integer" + "description": "the account of the guest VLAN range", + "name": "account", + "type": "string" }, { "description": "the zone of the guest vlan range", "name": "zoneid", "type": "long" }, + {}, + {}, { - "description": "the ID of the guest VLAN range", - "name": "id", - "type": "string" - }, - { - "description": "the domain name of the guest VLAN range", - "name": "domain", + "description": "the project id of the guest vlan range", + "name": "projectid", "type": "string" }, { - "description": "the account of the guest VLAN range", - "name": "account", + "description": "the guest VLAN range", + "name": "guestvlanrange", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the physical network of the guest vlan range", + "name": "physicalnetworkid", + "type": "long" }, { "description": "the domain ID of the guest VLAN range", @@ -111867,8 +112444,13 @@ "type": "string" }, { - "description": "the guest VLAN range", - "name": "guestvlanrange", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the ID of the guest VLAN range", + "name": "id", "type": "string" }, { @@ -111877,8 +112459,13 @@ "type": "string" }, { - "description": "the project id of the guest vlan range", - "name": "projectid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the domain name of the guest VLAN range", + "name": "domain", "type": "string" } ] @@ -111889,52 +112476,53 @@ "name": "updateIso", "params": [ { - "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 format for the image", "length": 255, - "name": "cleanupdetails", + "name": "format", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "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": "isdynamicallyscalable", + "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": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "true if image is bootable, false otherwise; available only for updateIso API", "length": 255, - "name": "requireshvm", + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "the ID of the OS type that best represents the OS of this image.", "length": 255, - "name": "arch", + "name": "ostypeid", + "related": "addGuestOs", "required": false, - "since": "4.20", - "type": "string" + "type": "uuid" }, { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", + "description": "sort key of the template, integer", + "length": 255, + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isrouting", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, @@ -111946,43 +112534,27 @@ "type": "boolean" }, { - "description": "sort key of the template, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, - { - "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.", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "forceupdateostype", + "name": "isrouting", "required": false, - "since": "4.21", "type": "boolean" }, { - "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 format for the image", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "format", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, - { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "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": "true if the image supports the password reset feature; default is false", "length": 255, @@ -111990,133 +112562,86 @@ "required": false, "type": "boolean" }, - { - "description": "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 name of the image file", "length": 255, "name": "name", "required": false, "type": "string" - } - ], - "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.", - "name": "deployasis", - "type": "boolean" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" - }, - {}, - { - "description": "the type of the template", - "name": "templatetype", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", + "required": false, "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", - "type": "boolean" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, + "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", + "required": true, + "type": "uuid" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "response": [ { - "description": "the project name of the template", - "name": "project", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" - }, - { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" - }, - {}, - { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" + "description": "the name of userdata linked to this template", + "name": "userdataname", + "type": "string" }, { - "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" }, { @@ -112125,108 +112650,83 @@ "type": "string" }, { - "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", + "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the account name to which the template belongs", - "name": "account", - "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 featured template, false otherwise", + "name": "isfeatured", + "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 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": "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 the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "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 featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "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": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "VMware only: true if template is deployed without orchestrating disks and networks but \"as-is\" defined in the template.", + "name": "deployasis", "type": "boolean" }, { @@ -112234,96 +112734,141 @@ "name": "tags", "response": [ { - "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 project name where tag belongs to", - "name": "project", + "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "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": "tag key name", - "name": "key", + "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 domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "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": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, { "description": "the template display text", "name": "displaytext", "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": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" + }, { "description": "the date this template was removed", "name": "removed", "type": "date" }, { - "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 ID of the secondary storage host for the template", - "name": "hostid", + "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": "the ID of the zone for this template", - "name": "zoneid", + "description": "the account name to which the template belongs", + "name": "account", "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 this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { @@ -112332,35 +112877,77 @@ "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" + }, + { + "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 account id to which the template belongs", - "name": "accountid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" + }, + {}, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "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", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, - {}, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the status of the template", + "name": "status", "type": "string" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" } ] }, @@ -112379,9 +112966,15 @@ } ], "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" }, { @@ -112390,17 +112983,11 @@ "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" - } + {} ] }, { @@ -112415,6 +113002,13 @@ "required": false, "type": "string" }, + { + "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" + }, { "description": "The certificate signing request (in pem format), if CSR is not provided then configured/provided options are considered", "length": 65535, @@ -112435,27 +113029,20 @@ "name": "provider", "required": false, "type": "string" - }, - { - "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", + "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", + "type": "string" }, { "description": "Private key for the certificate", @@ -112463,14 +113050,14 @@ "type": "string" }, { - "description": "The CA certificate(s)", - "name": "cacertificates", + "description": "The client certificate", + "name": "certificate", "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" }, {} ], @@ -112482,35 +113069,50 @@ "name": "createPortForwardingRule", "params": [ { - "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 starting port of port forwarding rule's public port range", "length": 255, - "name": "openfirewall", - "required": false, - "type": "boolean" + "name": "publicport", + "required": true, + "type": "integer" }, { - "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 IP address id of the port forwarding rule", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", - "required": false, + "name": "ipaddressid", + "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", + "required": true, "type": "uuid" }, { - "description": "VM guest nic secondary IP address for the port forwarding rule", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "vmguestip", + "name": "privateendport", "required": false, - "type": "string" + "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": "the ID of the virtual machine for the port forwarding rule", "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", + "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,createVMFromBackup,importVm", "required": true, "type": "uuid" }, + { + "description": "the starting port of port forwarding rule's private port range", + "length": 255, + "name": "privateport", + "required": true, + "type": "integer" + }, { "description": "the protocol for the port forwarding rule. Valid values are TCP or UDP.", "length": 255, @@ -112519,40 +113121,33 @@ "type": "string" }, { - "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": "publicendport", + "name": "openfirewall", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "the ending port of port forwarding rule's private port range", + "description": "VM guest nic secondary IP address for the port forwarding rule", "length": 255, - "name": "privateendport", + "name": "vmguestip", "required": false, - "type": "integer" - }, - { - "description": "the starting port of port forwarding rule's private port range", - "length": 255, - "name": "privateport", - "required": true, - "type": "integer" + "type": "string" }, { - "description": "the starting port of port forwarding rule's public port range", + "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": "publicport", - "required": true, - "type": "integer" + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", + "required": false, + "type": "uuid" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ending port of port forwarding rule's private port range", "length": 255, - "name": "fordisplay", + "name": "publicendport", "required": false, - "since": "4.4", - "type": "boolean" + "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.", @@ -112560,95 +113155,47 @@ "name": "cidrlist", "required": false, "type": "list" - }, - { - "description": "the IP address id of the port forwarding rule", - "length": 255, - "name": "ipaddressid", - "related": "associateIpAddress,updateIpAddress,associateIpAddress,listPublicIpAddresses", - "required": true, - "type": "uuid" } ], "related": "updatePortForwardingRule", "response": [ - { - "description": "the starting port of port forwarding rule's public port range", - "name": "publicport", - "type": "string" - }, - { - "description": "the id of the guest network the port forwarding rule belongs to", - "name": "networkid", - "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 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 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", - "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": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "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": "resource type", - "name": "resourcetype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -112657,41 +113204,61 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "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": "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 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": "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 ending port of port forwarding rule's private port range", - "name": "privateendport", + "name": "publicendport", "type": "string" }, { - "description": "the VM ID for the port forwarding rule", - "name": "virtualmachineid", + "description": "the protocol of the port forwarding rule", + "name": "protocol", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the VM ID for the port forwarding rule", + "name": "virtualmachineid", "type": "string" }, { @@ -112699,16 +113266,24 @@ "name": "privateport", "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", "type": "string" }, - {}, - {}, { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "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" }, { @@ -112717,14 +113292,26 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 public ip address for the port forwarding rule", "name": "ipaddress", "type": "string" + }, + { + "description": "the ID of the port forwarding rule", + "name": "id", + "type": "string" } ] }, @@ -112737,18 +113324,10 @@ "description": "template ID of the template to be prepared in primary storage(s).", "length": 255, "name": "templateid", - "related": "prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,prepareTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, - { - "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": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" - }, { "description": "zone ID of the template to be prepared in primary storage(s).", "length": 255, @@ -112756,38 +113335,76 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "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": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", + "required": false, + "type": "uuid" } ], - "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ { - "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 secondary storage host for the template", + "name": "hostname", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -112795,13 +113412,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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" }, { @@ -112815,13 +113432,13 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -112830,8 +113447,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -112840,173 +113457,153 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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" } ], "type": "set" }, { - "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 account id to which the template belongs", - "name": "accountid", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "checksum of the template", + "name": "checksum", "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the template name", - "name": "name", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "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 account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "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": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the name of the zone for this template", + "name": "zonename", + "type": "string" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "the URL which the template/iso is registered from", + "name": "url", + "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "the template display text", + "name": "displaytext", + "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 ready to be deployed from, false otherwise.", + "name": "isready", "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 template requires HVM enabled, false otherwise", "name": "requireshvm", "type": "boolean" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "the date this template was created", - "name": "created", - "type": "date" - }, - { - "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 ID of the secondary storage host for the template", - "name": "hostid", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "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", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the tag of this template", + "name": "templatetag", "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 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": "The name of extension linked to this template", @@ -113014,106 +113611,96 @@ "type": "string" }, { - "description": "the project name of the template", - "name": "project", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "checksum of the template", - "name": "checksum", + "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 name of userdata linked to this template", + "name": "userdataname", "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the template name", + "name": "name", "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": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "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": "the type of the template", + "name": "templatetype", + "type": "string" }, {}, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the project id of the template", - "name": "projectid", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the template ID", - "name": "id", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "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 the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "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 size of the template", + "name": "size", + "type": "long" } ] }, @@ -113123,12 +113710,11 @@ "name": "dedicateZone", "params": [ { - "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,listDomains,listDomains", - "required": true, - "type": "uuid" + "name": "account", + "required": false, + "type": "string" }, { "description": "the ID of the zone", @@ -113139,11 +113725,12 @@ "type": "uuid" }, { - "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,listDomains,listDomains", + "required": true, + "type": "uuid" } ], "related": "", @@ -113155,8 +113742,13 @@ "type": "string" }, { - "description": "the ID of the dedicated resource", - "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" }, { @@ -113164,6 +113756,11 @@ "name": "domainid", "type": "string" }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, { "description": "the Account Id to which the Zone is dedicated", "name": "accountid", @@ -113171,24 +113768,14 @@ }, {}, { - "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 Dedication Affinity Group ID of the zone", "name": "affinitygroupid", "type": "string" - }, - { - "description": "the ID of the Zone", - "name": "zoneid", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -113198,16 +113785,16 @@ "name": "updateBackupOffering", "params": [ { - "description": "The name of the Backup Offering to be updated", + "description": "Whether to allow user driven backups or not", "length": 255, - "name": "name", + "name": "allowuserdrivenbackups", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "The description of the Backup Offering to be updated", + "description": "The name of the Backup Offering to be updated", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" }, @@ -113220,30 +113807,18 @@ "type": "uuid" }, { - "description": "Whether to allow user driven backups or not", + "description": "The description of the Backup Offering to be updated", "length": 255, - "name": "allowuserdrivenbackups", + "name": "description", "required": false, - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "zone ID", - "name": "zoneid", - "type": "string" - }, - {}, - { - "description": "the date this backup offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "name for the backup offering", - "name": "name", + "description": "provider name", + "name": "provider", "type": "string" }, { @@ -113252,39 +113827,56 @@ "type": "boolean" }, { - "description": "provider name", - "name": "provider", + "description": "zone ID", + "name": "zoneid", "type": "string" }, + { + "description": "the backups with this offering can be used to create Instances on all Zones", + "name": "crosszoneinstancecreation", + "type": "boolean" + }, { "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": "the date this backup offering was created", + "name": "created", + "type": "date" }, { - "description": "external ID on the provider side", - "name": "externalid", + "description": "description for the backup offering", + "name": "description", "type": "string" }, + {}, { - "description": "description for the backup offering", - "name": "description", + "description": "ID of the backup offering", + "name": "id", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + { + "description": "external ID on the provider side", + "name": "externalid", + "type": "string" + }, { "description": "zone name", "name": "zonename", "type": "string" + }, + { + "description": "name for the backup offering", + "name": "name", + "type": "string" } ], "since": "4.16.0" @@ -113295,19 +113887,19 @@ "name": "listBuckets", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "createDomain,listDomains,listDomains", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List by keyword", + "description": "the ID of the object storage pool, available to ROOT admin only", "length": 255, - "name": "keyword", + "name": "objectstorageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list objects by project; if projectid=-1 lists All VMs", @@ -113318,11 +113910,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 keyword", "length": 255, - "name": "isrecursive", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the name of the bucket", @@ -113332,12 +113938,34 @@ "type": "string" }, { - "description": "the IDs of the Buckets, mutually exclusive with id", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "ids", + "name": "isrecursive", + "required": false, + "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 only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "createDomain,listDomains,listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "the ID of the bucket", + "length": 255, + "name": "id", "related": "listBuckets", "required": false, - "type": "list" + "type": "uuid" }, { "description": "List resources by tags (key/value pairs)", @@ -113347,157 +113975,178 @@ "type": "map" }, { - "description": "", + "description": "the IDs of the Buckets, mutually exclusive with id", "length": 255, - "name": "pagesize", + "name": "ids", + "related": "listBuckets", "required": false, - "type": "integer" + "type": "list" + } + ], + "related": "", + "response": [ + { + "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": "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 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": "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": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, + "description": "the ID of the domain associated with the bucket", + "name": "domainid", "type": "string" }, { - "description": "the ID of the object storage pool, available to ROOT admin only", - "length": 255, - "name": "objectstorageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities", - "required": false, - "type": "uuid" + "description": "path of the domain to which the bucket belongs", + "name": "domainpath", + "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": "Object storage provider", + "name": "provider", + "type": "string" }, { - "description": "the ID of the bucket", - "length": 255, - "name": "id", - "related": "listBuckets", - "required": false, - "type": "uuid" + "description": "Bucket Encryption", + "name": "encryption", + "type": "boolean" }, - { - "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", + "description": "the account associated with the Bucket", + "name": "account", "type": "string" }, { - "description": "Bucket Access Policy", - "name": "policy", + "description": "Bucket Access Key", + "name": "accesskey", "type": "string" }, { - "description": "State of the Bucket", - "name": "state", + "description": "id of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstorageid", "type": "string" }, { - "description": "name of the Bucket", - "name": "name", + "description": "Name of the object storage hosting the Bucket; returned to admin user only", + "name": "objectstore", "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", + "description": "ID of the Bucket", + "name": "id", "type": "string" }, { - "description": "Object storage provider", - "name": "provider", - "type": "string" + "description": "Bucket Versioning", + "name": "versioning", + "type": "boolean" }, { - "description": "Bucket Object Locking", - "name": "objectlocking", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "ID of the Bucket", - "name": "id", - "type": "string" + "description": "Bucket Quota in GiB", + "name": "quota", + "type": "integer" }, {}, { - "description": "Name of the object storage hosting the Bucket; returned to admin user only", - "name": "objectstore", + "description": "Bucket URL", + "name": "url", "type": "string" }, { - "description": "Bucket Encryption", - "name": "encryption", - "type": "boolean" - }, - { - "description": "the account associated with the Bucket", - "name": "account", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Bucket URL", - "name": "url", - "type": "string" + "description": "Total size of objects in Bucket", + "name": "size", + "type": "long" }, { - "description": "Bucket Access Key", - "name": "accesskey", + "description": "the domain associated with the bucket", + "name": "domain", "type": "string" }, { - "description": "the project id of the bucket", - "name": "projectid", + "description": "State of the Bucket", + "name": "state", "type": "string" }, { - "description": "Bucket Quota in GiB", - "name": "quota", - "type": "integer" + "description": "name of the Bucket", + "name": "name", + "type": "string" }, { - "description": "the domain associated with the bucket", - "name": "domain", + "description": "Bucket Secret Key", + "name": "usersecretkey", "type": "string" }, { @@ -113506,81 +114155,24 @@ "type": "date" }, { - "description": "Bucket Versioning", - "name": "versioning", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Total size of objects in Bucket", - "name": "size", - "type": "long" + "description": "Bucket Access Policy", + "name": "policy", + "type": "string" }, { - "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": "Bucket Object Locking", + "name": "objectlocking", + "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the bucket", + "name": "projectid", + "type": "string" } ], "since": "4.19.0" @@ -113609,33 +114201,70 @@ "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "response": [ { - "description": "the gateway for the router", - "name": "gateway", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "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": "result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "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": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + } + ], + "type": "list" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the name of VPC the router belongs to", - "name": "vpcname", + "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 router", - "name": "name", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, {}, @@ -113645,60 +114274,79 @@ "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, - {}, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", + "description": "the project id of the ipaddress", + "name": "projectid", + "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 first DNS for the router", - "name": "dns1", + "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 guest network", - "name": "guestnetworkid", + "description": "the version of the code / software in the router", + "name": "softwareversion", "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "role of the domain router", + "name": "role", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the name of VPC the router belongs to", + "name": "vpcname", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the first DNS for the router", + "name": "dns1", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the network domain for the router", + "name": "networkdomain", "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" }, { "description": "the ID of the service offering of the virtual machine", @@ -113706,50 +114354,28 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the hostname for the router", + "name": "hostname", + "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": "detailed response generated on running health check", - "name": "details", - "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" - } - ], - "type": "list" + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "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 guest IP address for the router", - "name": "guestipaddress", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -113758,18 +114384,18 @@ "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -113778,147 +114404,188 @@ "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the link local netmask for the router", - "name": "linklocalnetmask", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + { + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the version of template", - "name": "version", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the Pod name for the router", + "name": "podname", "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 virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "description": "the id of the router", + "name": "id", + "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain associated with the router", + "name": "domain", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the state of redundant virtual router", + "name": "redundantstate", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "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": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, { "description": "the list of nics associated with the router", "name": "nic", "response": [ { - "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": "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": "the ID of the nic", - "name": "id", + "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": "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", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "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", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -113927,165 +114594,258 @@ "type": "string" }, { - "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "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": "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "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", + "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 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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ip address of the nic", + "name": "ipaddress", "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 gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" } ], "type": "set" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the second DNS for the router", - "name": "dns2", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the template ID for the router", + "name": "templateid", "type": "string" + } + ] + }, + { + "description": "Creates a GPU device manually on a host", + "isasync": false, + "name": "createGpuDevice", + "params": [ + { + "description": "ID of the host where the GPU device is located", + "length": 255, + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", + "required": true, + "type": "uuid" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "ID of the GPU card type", + "length": 255, + "name": "gpucardid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "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 guest netmask for the router", - "name": "guestnetmask", + "description": "ID of the vGPU profile", + "length": 255, + "name": "vgpuprofileid", + "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" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", + "length": 255, + "name": "type", + "required": false, "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "ID of the parent GPU device (for virtual GPU devices)", + "length": 255, + "name": "parentgpudeviceid", + "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", + "required": false, + "type": "uuid" + } + ], + "related": "listGpuDevices,discoverGpuDevices", + "response": [ + { + "description": "the vGPU profile name assigned to this GPU device", + "name": "state", + "type": "state" + }, + { + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the vGPU profile ID assigned to this GPU device", + "name": "virtualmachineid", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "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 template ID for the router", - "name": "templateid", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the vGPU profile name assigned to this GPU device", + "name": "virtualmachinename", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "bus address of the GPU device", + "name": "gpudevicetype", + "type": "devicetype" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "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 state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" + }, + { + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", + "type": "string" + }, + { + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "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" } - ] + ], + "since": "4.21.0" }, { "description": "Updates a security group", "isasync": false, "name": "updateSecurityGroup", "params": [ + { + "description": "The new name of the security group.", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "The ID of the security group.", "length": 255, @@ -114094,13 +114854,6 @@ "required": true, "type": "uuid" }, - { - "description": "The new name of the security group.", - "length": 255, - "name": "name", - "required": false, - "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, @@ -114113,15 +114866,91 @@ "related": "", "response": [ { - "description": "the project name of the group", - "name": "project", + "description": "the name of the security group", + "name": "name", "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 resource tags associated with the rule", + "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": "id of the resource", + "name": "resourceid", + "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 project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the account owning the security group", + "name": "account", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "type": "string" }, { "description": "the ID of the security group", @@ -114132,28 +114961,38 @@ "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 protocol of the security group rule", + "name": "protocol", + "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 list of resource tags associated with the rule", "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": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -114162,13 +115001,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" - }, - { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -114177,8 +115011,8 @@ "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -114188,223 +115022,188 @@ }, { "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": "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 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 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 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 domain associated with the tag", - "name": "domain", - "type": "string" + "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 domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "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 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": "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": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "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" } ], "type": "set" }, + { + "description": "the domain ID of the security group", + "name": "domainid", + "type": "string" + }, + {}, { "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", + "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 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": "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project id of the group", - "name": "projectid", + "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 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", + "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 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", + "type": "string" + }, + { + "description": "security group name", + "name": "securitygroupname", + "type": "string" + }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag key name", - "name": "key", + "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 ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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 project id the tag belongs to", + "name": "projectid", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -114413,139 +115212,73 @@ "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": "account owning the security group rule", - "name": "account", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "type": "string" - }, - { - "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", - "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 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", + "description": "SP initiated SAML Single Sign On", "isasync": false, - "name": "createGpuDevice", + "name": "samlSso", "params": [ { - "description": "Type of GPU device (PCI, MDEV, VGPUOnly). Defaults to PCI.", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "ID of the host where the GPU device is located", + "description": "Identity Provider Entity ID", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "idpid", "required": true, - "type": "uuid" - }, + "type": "string" + } + ], + "related": "", + "response": [ + {}, { - "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, + "description": "Two factor authentication issuer", + "name": "issuerfor2fa", "type": "string" }, { - "description": "ID of the parent GPU device (for virtual GPU devices)", - "length": 255, - "name": "parentgpudeviceid", - "related": "listGpuDevices,discoverGpuDevices,createGpuDevice", - "required": false, - "type": "uuid" + "description": "user time zone", + "name": "timezone", + "type": "string" }, { - "description": "ID of the vGPU profile", - "length": 255, - "name": "vgpuprofileid", - "related": "", - "required": true, - "type": "uuid" + "description": "the time period before the session has expired", + "name": "timeout", + "type": "integer" }, { - "description": "ID of the GPU card type", - "length": 255, - "name": "gpucardid", - "related": "", - "required": true, - "type": "uuid" + "description": "user time zoneoffset", + "name": "timezoneoffset", + "type": "string" }, { - "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, + "description": "Is user registered", + "name": "registered", "type": "string" - } - ], - "related": "listGpuDevices,discoverGpuDevices", - "response": [ + }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", + "description": "Two factor authentication provider", + "name": "providerfor2fa", "type": "string" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "User ID", + "name": "userid", "type": "string" }, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", + "description": "Is two factor authentication enabled", + "name": "is2faenabled", "type": "string" }, { @@ -114553,86 +115286,71 @@ "name": "jobstatus", "type": "integer" }, - {}, - {}, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "virtualmachineid", + "description": "the account type (admin, domain-admin, read-only-admin, user)", + "name": "type", "type": "string" }, { - "description": "the ID of the GPU device", - "name": "id", + "description": "Session key that can be passed in subsequent Query command calls", + "name": "sessionkey", "type": "string" }, + {}, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "last name of the user", + "name": "lastname", "type": "string" }, { - "description": "bus address of the GPU device", - "name": "gpudevicetype", - "type": "devicetype" - }, - { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "Username", + "name": "username", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "first name of the user", + "name": "firstname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Is two factor authentication verified", + "name": "is2faverified", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "Domain ID that the user belongs to", + "name": "domainid", "type": "string" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "description": "Management Server ID that the user logged to", + "name": "managementserverid", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", + "description": "the account name the user belongs to", + "name": "account", "type": "string" - }, - { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" } - ], - "since": "4.21.0" + ] }, { "description": "Creates a domain", "isasync": false, "name": "createDomain", "params": [ + { + "description": "creates domain with this name", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Network domain for networks in the domain", "length": 255, @@ -114641,10 +115359,10 @@ "type": "string" }, { - "description": "creates domain with this name", + "description": "Domain UUID, required for adding domain from another Region", "length": 255, - "name": "name", - "required": true, + "name": "domainid", + "required": false, "type": "string" }, { @@ -114654,65 +115372,33 @@ "related": "createDomain,listDomains,listDomains", "required": false, "type": "uuid" - }, - { - "description": "Domain UUID, required for adding domain from another Region", - "length": 255, - "name": "domainid", - "required": false, - "type": "string" } ], "related": "listDomains,listDomains", "response": [ { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "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 total number of vpcs available to be created for this domain", - "name": "vpcavailable", - "type": "string" - }, - { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" - }, - { - "description": "the total number of backups which can be stored by this domain", - "name": "backuplimit", + "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 total volume which can be used by this domain", - "name": "volumelimit", + "description": "the total backup storage space (in GiB) available to the domain", + "name": "backupstorageavailable", "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", + "description": "the total volume being used by this domain", + "name": "volumetotal", "type": "long" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of gpus the domain can own", + "name": "gpulimit", "type": "string" }, { @@ -114721,69 +115407,49 @@ "type": "long" }, { - "description": "the total number of public ip addresses allocated for this domain", - "name": "iptotal", + "description": "the total memory (in MB) owned by domain", + "name": "memorytotal", "type": "long" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this domain", - "name": "snapshotlimit", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", - "type": "long" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "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 path of the domain", - "name": "path", + "description": "the total number of backups which can be stored by this domain", + "name": "backuplimit", "type": "string" }, + {}, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total memory (in MB) owned by domain", - "name": "memorytotal", - "type": "long" - }, - { - "description": "details for the domain", - "name": "domaindetails", - "type": "map" - }, - { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of networks the domain can own", + "name": "networklimit", + "type": "string" }, - {}, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { @@ -114792,19 +115458,14 @@ "type": "string" }, { - "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 tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { - "description": "the total volume available for this domain", - "name": "volumeavailable", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the domain", + "name": "backupstoragetotal", + "type": "long" }, { "description": "the total number of projects the domain can own", @@ -114817,134 +115478,154 @@ "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total number of backups available to this domain", + "name": "backupavailable", + "type": "string" }, { - "description": "the total number of virtual machines deployed by this domain", - "name": "vmtotal", + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this domain", - "name": "cpuavailable", + "description": "the total memory (in MB) the domain can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the domain", - "name": "backupstorageavailable", + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", "type": "string" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total number of cpu cores the domain can own", + "name": "cpulimit", "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", + "description": "the total number of projects being administrated by this domain", + "name": "projecttotal", "type": "long" }, { - "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": "the total secondary storage space (in GiB) available to be used for this domain", - "name": "secondarystorageavailable", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of gpus the domain can own", - "name": "gpulimit", + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", - "type": "string" + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the domain name of the parent domain", + "name": "parentdomainname", "type": "string" }, { - "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 volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, { "description": "the total number of networks available to be created for this domain", "name": "networkavailable", "type": "string" }, + {}, + { + "description": "the total number of buckets stored by this domain", + "name": "buckettotal", + "type": "long" + }, { "description": "the total number of gpus available to be created for this domain", "name": "gpuavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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 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 number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "the total number of vpcs the domain can own", - "name": "vpclimit", + "description": "details for the domain", + "name": "domaindetails", + "type": "map" + }, + { + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "whether the domain has one or more sub-domains", - "name": "haschild", - "type": "boolean" + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", + "type": "string" }, { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total secondary storage space (in GiB) the domain can own", + "name": "secondarystoragelimit", "type": "string" }, { @@ -114953,54 +115634,84 @@ "type": "string" }, { - "description": "the total number of public ip addresses available for this domain to acquire", - "name": "ipavailable", + "description": "the path of the domain", + "name": "path", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total number of public ip addresses allocated for this domain", + "name": "iptotal", + "type": "long" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", "type": "long" }, { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "the total number of snapshots which can be stored by this domain", + "name": "snapshotlimit", "type": "string" }, { - "description": "The tagged resource limit and count for the domain", - "name": "taggedresources", - "type": "list" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the ID of the domain", - "name": "id", + "description": "the total volume available for this domain", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of networks the domain can own", - "name": "networklimit", + "description": "the level of the domain", + "name": "level", + "type": "integer" + }, + { + "description": "the total number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" + }, + { + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "type": "long" }, { - "description": "the total number of public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", "type": "string" }, { "description": "the total number of virtual machines that can be deployed by this domain", "name": "vmlimit", "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", + "name": "id", + "type": "string" } ] }, @@ -115010,19 +115721,26 @@ "name": "addImageStore", "params": [ { - "description": "the Zone ID for the image store", + "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": "zoneid", - "related": "listZones", + "name": "details", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "the name for 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" }, { "description": "the image store provider name", @@ -115032,30 +115750,18 @@ "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", + "description": "the name for the image store", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "map" + "type": "string" } ], "related": "addSecondaryStorage,listSwifts", "response": [ { - "description": "the protocol of the image store", - "name": "protocol", - "type": "string" - }, - { - "description": "the provider name of the image store", - "name": "providername", + "description": "the name of the image store", + "name": "name", "type": "string" }, { @@ -115065,45 +115771,55 @@ }, {}, { - "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": "defines if store is read-only", - "name": "readonly", - "type": "boolean" + "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 url of the image store", - "name": "url", + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, { "description": "the scope of the image store", "name": "scope", "type": "scopetype" }, + { + "description": "the url of the image store", + "name": "url", + "type": "string" + }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, { - "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 total disk size of the host", @@ -115111,14 +115827,9 @@ "type": "long" }, { - "description": "the ID of the image store", - "name": "id", - "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" } ], "since": "4.2.0" @@ -115128,13 +115839,6 @@ "isasync": false, "name": "revokeTemplateDirectDownloadCertificate", "params": [ - { - "description": "(optional) alias of the SSL certificate", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "(optional) hypervisor type", "length": 255, @@ -115143,20 +115847,19 @@ "type": "string" }, { - "description": "id of the certificate", + "description": "(optional) the host ID to revoke certificate", "length": 255, - "name": "id", - "related": "listTemplateDirectDownloadCertificates", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "(optional) the host ID to revoke certificate", + "description": "(optional) alias of the SSL certificate", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { "description": "(optional) zone to revoke certificate", @@ -115165,6 +115868,14 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "id of the certificate", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" } ], "related": "provisionTemplateDirectDownloadCertificate", @@ -115174,31 +115885,31 @@ "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", + "description": "indicates if the certificate has been revoked from the host, failed or skipped", + "name": "status", "type": "string" }, {}, + {}, { "description": "the ID of the host", "name": "hostid", "type": "string" }, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "description": "indicates the details in case of failure or host skipped", + "name": "details", + "type": "string" + }, + { + "description": "the name of the host", + "name": "hostname", "type": "string" } ], @@ -115221,181 +115932,186 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "response": [ { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the name of the storage pool", + "name": "name", "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" }, { - "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the storage pool path", + "name": "path", "type": "string" }, - {}, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "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 pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, - {}, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "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 hypervisor type of the storage pool", + "name": "hypervisor", + "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 host's currently allocated disk size", - "name": "disksizeallocated", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" - }, - { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", + "type": "string" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { - "description": "the storage pool type", - "name": "type", - "type": "string" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "description": "the Zone ID of the storage pool", + "name": "zoneid", + "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, + {}, { - "description": "the host's currently used disk size", - "name": "disksizeused", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", - "type": "string" + "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": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod name of the storage pool", - "name": "podname", - "type": "string" + "description": "the total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, + {}, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the pool's currently used disk size", + "name": "disksizeused", "type": "long" }, { "description": "whether this pool is managed or not", "name": "managed", "type": "boolean" + }, + { + "description": "the ID of the storage pool", + "name": "id", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.16.0" @@ -115406,16 +116122,16 @@ "name": "unregisterExtension", "params": [ { - "description": "Type of the resource", + "description": "ID of the resource to register the extension with", "length": 255, - "name": "resourcetype", + "name": "resourceid", "required": true, "type": "string" }, { - "description": "ID of the resource to register the extension with", + "description": "Type of the resource", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": true, "type": "string" }, @@ -115430,15 +116146,37 @@ ], "related": "listExtensions,updateExtension", "response": [ + { + "description": "ID of the extension", + "name": "id", + "type": "string" + }, {}, { "description": "The path of the entry point fo the extension", "name": "path", "type": "string" }, + {}, { - "description": "ID of the extension", - "name": "id", + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, + { + "description": "Name of the extension", + "name": "name", + "type": "string" + }, + {}, + { + "description": "Type of the extension", + "name": "type", + "type": "string" + }, + { + "description": "The state of the extension", + "name": "state", "type": "string" }, { @@ -115446,6 +116184,36 @@ "name": "removed", "type": "date" }, + { + "description": "Creation timestamp of the extension", + "name": "created", + "type": "date" + }, + { + "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" + }, + { + "description": "Description of the extension", + "name": "description", + "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", + "type": "string" + }, { "description": "List of resources to which extension is registered to", "name": "resources", @@ -115455,16 +116223,16 @@ "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": "the details of the resource map", + "name": "details", + "type": "map" + }, { "description": "Type of the resource", "name": "type", @@ -115477,59 +116245,7 @@ } ], "type": "list" - }, - { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" - }, - { - "description": "The details of the extension", - "name": "details", - "type": "map" - }, - {}, - { - "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": "Type of the extension", - "name": "type", - "type": "string" - }, - { - "description": "The state of the extension", - "name": "state", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Description of the extension", - "name": "description", - "type": "string" - }, - {} + } ], "since": "4.21.0" }, @@ -115539,23 +116255,23 @@ "name": "listNsxControllers", "params": [ { - "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": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -115570,46 +116286,36 @@ ], "related": "", "response": [ - { - "description": "NSX controller port", - "name": "port", - "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" }, { - "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", + "description": "NSX controller port", + "name": "port", "type": "string" }, {}, - {}, { - "description": "NSX controller name", - "name": "name", + "description": "NSX controller hostname or IP address", + "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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", + "description": "Zone ID to which the NSX controller is associated with", + "name": "zoneid", "type": "string" }, + {}, { - "description": "NSX controller hostname or IP address", - "name": "hostname", + "description": "Zone name to which the NSX controller is associated with", + "name": "zonename", "type": "string" }, { @@ -115623,8 +116329,18 @@ "type": "string" }, { - "description": "NSX controller ID", - "name": "nsxprovideruuid", + "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": "The name of the transport zone. A transport zone controls to which hosts a logical switch can reach", + "name": "transportzone", "type": "string" } ], @@ -115636,10 +116352,10 @@ "name": "assignVolume", "params": [ { - "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", + "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", "length": 255, - "name": "accountid", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -115652,10 +116368,10 @@ "type": "uuid" }, { - "description": "The ID of the project to which the volume will be assigned. Mutually exclusive with 'accountid'.", + "description": "The ID of the account to which the volume will be assigned. Mutually exclusive with parameter 'projectid'.", "length": 255, - "name": "projectid", - "related": "", + "name": "accountid", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, "type": "uuid" } @@ -115663,38 +116379,68 @@ "related": "createVolume,updateVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" + }, + { + "description": "shared or local storage", + "name": "storagetype", + "type": "string" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" + }, + { + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", + "type": "string" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "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", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { @@ -115703,13 +116449,18 @@ "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { @@ -115718,8 +116469,8 @@ "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { @@ -115728,23 +116479,13 @@ "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": "pod id of the volume", - "name": "podid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "the boolean state of whether the volume is destroyed or not", + "name": "destroyed", "type": "boolean" }, { @@ -115753,13 +116494,8 @@ "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { @@ -115768,122 +116504,138 @@ "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "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", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "max iops of the disk volume", + "name": "maxiops", "type": "long" }, { - "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": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "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 bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "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": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "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 value", + "name": "value", "type": "string" }, { @@ -115892,13 +116644,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -115907,13 +116659,8 @@ "type": "string" }, { - "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" }, { @@ -115922,86 +116669,76 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "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": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "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 primary storage hosting the disk volume", - "name": "storage", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "name of the disk volume", + "name": "name", + "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "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 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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { @@ -116010,29 +116747,19 @@ "type": "long" }, { - "description": "name of the disk volume", - "name": "name", - "type": "string" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", - "type": "string" - }, - { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { "description": "the disk utilization", @@ -116040,50 +116767,39 @@ "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" - }, - {}, - { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "true if volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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 date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, {} ], @@ -116101,14 +116817,6 @@ "required": false, "type": "string" }, - { - "description": "the ID of the Userdata", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "an optional domainId for the userdata. If the account parameter is used, domainId must also be used.", "length": 255, @@ -116117,6 +116825,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the Userdata", + "length": 255, + "name": "id", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "an optional project for the userdata", "length": 255, @@ -116127,27 +116843,27 @@ } ], "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 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.18" @@ -116157,13 +116873,6 @@ "isasync": false, "name": "listSupportedNetworkServices", "params": [ - { - "description": "network service name to list providers and capabilities of", - "length": 255, - "name": "service", - "required": false, - "type": "string" - }, { "description": "network service provider name", "length": 255, @@ -116185,6 +116894,13 @@ "required": false, "type": "integer" }, + { + "description": "network service name to list providers and capabilities of", + "length": 255, + "name": "service", + "required": false, + "type": "string" + }, { "description": "", "length": 255, @@ -116195,54 +116911,36 @@ ], "related": "", "response": [ - { - "description": "the service name", - "name": "name", - "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 destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the capability name", - "name": "name", - "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 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": "state of the network provider", "name": "state", "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" + }, { "description": "uuid of the network provider", "name": "id", @@ -116252,29 +116950,47 @@ "description": "the provider name", "name": "name", "type": "string" - }, + } + ], + "type": "list" + }, + { + "description": "the list of capabilities", + "name": "capability", + "response": [ { - "description": "services for this provider", - "name": "servicelist", - "type": "list" + "description": "the capability name", + "name": "name", + "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 physical network this belongs to", - "name": "physicalnetworkid", - "type": "string" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the capability value", + "name": "value", "type": "string" } ], "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "3.0.0" @@ -116295,11 +117011,16 @@ ], "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", @@ -116307,14 +117028,9 @@ }, {}, { - "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" } ] }, @@ -116324,18 +117040,11 @@ "name": "addNetworkServiceProvider", "params": [ { - "description": "the name for the physical network service provider", - "length": 255, - "name": "name", - "required": true, - "type": "string" - }, - { - "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" }, { @@ -116346,46 +117055,43 @@ "type": "list" }, { - "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", + "length": 255, + "name": "name", + "required": true, + "type": "string" } ], "related": "listTrafficTypes", "response": [ {}, - {}, - { - "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" }, { - "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 destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { - "description": "the provider name", - "name": "name", + "description": "uuid of the network provider", + "name": "id", "type": "string" }, + {}, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -116393,15 +117099,25 @@ "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": "state of the network provider", - "name": "state", + "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": "3.0.0" @@ -116422,26 +117138,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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" } ] }, @@ -116460,26 +117176,26 @@ } ], "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": "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": "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" } ], @@ -116491,72 +117207,72 @@ "name": "createServiceOffering", "params": [ { - "description": "the ID of the vGPU profile to which service offering should be mapped", + "description": "io requests read rate of the disk offering", "length": 255, - "name": "vgpuprofileid", - "related": "", + "name": "iopsreadrate", "required": false, - "since": "4.21", - "type": "uuid" + "type": "long" }, { - "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": "The display text of the service offering, defaults to 'name'.", "length": 255, - "name": "cpuspeed", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", "length": 255, - "name": "hosttags", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "the storage type of the service offering. Values are local and shared.", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "storagetype", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "is this a system vm offering", + "description": "data transfer rate in megabits per second allowed. Supported only for non-System offering and system offerings having \"domainrouter\" systemvmtype", "length": 255, - "name": "issystem", + "name": "networkrate", "required": false, - "type": "boolean" + "type": "integer" }, { - "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": "The minimum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "deploymentplanner", + "name": "mincpunumber", "required": false, - "type": "string" + "since": "4.13", + "type": "integer" }, { - "description": "whether compute offering iops is custom or not", + "description": "the ID of the disk offering to which service offering should be mapped", "length": 255, - "name": "customizediops", + "name": "diskofferingid", + "related": "", "required": false, - "since": "4.4", - "type": "boolean" + "since": "4.17", + "type": "uuid" }, { - "description": "bytes write rate of the disk offering", + "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": "byteswriterate", + "name": "isvolatile", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "Name of the storage policy defined at vCenter, this is applicable only for VMware", + "description": "The maximum memory size of the custom service offering in MB", "length": 255, - "name": "storagepolicy", - "related": "", + "name": "maxmemory", "required": false, - "since": "4.15", - "type": "uuid" + "since": "4.13", + "type": "integer" }, { "description": "the tags for this service offering.", @@ -116566,27 +117282,28 @@ "type": "string" }, { - "description": "io requests read rate of the disk offering", + "description": "whether compute offering iops is custom or not", "length": 255, - "name": "iopsreadrate", + "name": "customizediops", "required": false, - "type": "long" + "since": "4.4", + "type": "boolean" }, { - "description": "burst io requests write rate of the disk offering", + "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", "length": 255, - "name": "iopswriteratemax", + "name": "gpucount", "required": false, - "type": "long" + "since": "4.21", + "type": "integer" }, { - "description": "the ID of the containing zone(s), null for public offerings", + "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": "zoneid", - "related": "listZones", + "name": "diskofferingstrictness", "required": false, - "since": "4.13", - "type": "list" + "since": "4.17", + "type": "boolean" }, { "description": "length (in seconds) of the burst", @@ -116596,20 +117313,19 @@ "type": "long" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", + "description": "Whether service offering size is custom or not", "length": 255, - "name": "cachemode", + "name": "customized", "required": false, - "since": "4.14", - "type": "string" + "since": "4.13", + "type": "boolean" }, { - "description": "The maximum memory size of the custom service offering in MB", + "description": "bytes read rate of the disk offering", "length": 255, - "name": "maxmemory", + "name": "bytesreadrate", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { "description": "length (in seconds) of the burst", @@ -116619,155 +117335,148 @@ "type": "long" }, { - "description": "the system VM type. Possible types are \"domainrouter\", \"consoleproxy\" and \"secondarystoragevm\".", + "description": "restrict the CPU usage to committed service offering", "length": 255, - "name": "systemvmtype", + "name": "limitcpuuse", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "VMs using this offering require root volume encryption", + "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": "encryptroot", + "name": "deploymentplanner", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" }, { - "description": "Whether service offering size is custom or not", + "description": "the storage type of the service offering. Values are local and shared.", "length": 255, - "name": "customized", + "name": "storagetype", "required": false, - "since": "4.13", - "type": "boolean" + "type": "string" }, { - "description": "The maximum number of CPUs to be set with Custom Computer Offering", + "description": "io requests write rate of the disk offering", "length": 255, - "name": "maxcpunumber", + "name": "iopswriterate", "required": false, - "since": "4.13", - "type": "integer" + "type": "long" }, { - "description": "the Root disk size in GB.", + "description": "the total memory of the service offering in MB", "length": 255, - "name": "rootdisksize", + "name": "memory", "required": false, - "since": "4.15", - "type": "long" + "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "burst bytes write rate of the disk offering", "length": 255, - "name": "byteswriteratemaxlength", + "name": "byteswriteratemax", "required": false, "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", + "description": "Number of days instance is leased for.", "length": 255, - "name": "limitcpuuse", + "name": "leaseduration", "required": false, - "type": "boolean" + "since": "4.21.0", + "type": "integer" }, { - "description": "bytes read rate of the disk offering", + "description": "details for planner, used to store specific parameters", "length": 255, - "name": "bytesreadrate", + "name": "serviceofferingdetails", "required": false, - "type": "long" + "type": "map" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "description": "max iops of the compute offering", "length": 255, - "name": "dynamicscalingenabled", + "name": "maxiops", "required": false, - "since": "4.16", - "type": "boolean" + "since": "4.4", + "type": "long" }, { - "description": "the HA for the service offering", + "description": "bytes write rate of the disk offering", "length": 255, - "name": "offerha", + "name": "byteswriterate", "required": false, - "type": "boolean" + "type": "long" }, { - "description": "Number of days instance is leased for.", + "description": "The maximum number of CPUs to be set with Custom Computer Offering", "length": 255, - "name": "leaseduration", + "name": "maxcpunumber", "required": false, - "since": "4.21.0", + "since": "4.13", "type": "integer" }, { - "description": "Count of GPUs to be used with this service offering. This is applicable only when passed with vGPU profile.", + "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", "length": 255, - "name": "gpucount", + "name": "hypervisorsnapshotreserve", "required": false, - "since": "4.21", + "since": "4.4", "type": "integer" }, { - "description": "burst requests read rate of the disk offering", + "description": "the HA for the service offering", "length": 255, - "name": "iopsreadratemax", + "name": "offerha", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the ID of the containing domain(s), null for public offerings", + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default. If the hypervisor default cache mode is used on other hypervisors than KVM, it will fall back to none cache mode", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "cachemode", "required": false, - "type": "list" + "since": "4.14", + "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": "Name of the storage policy defined at vCenter, this is applicable only for VMware", "length": 255, - "name": "isvolatile", + "name": "storagepolicy", + "related": "", "required": false, - "type": "boolean" + "since": "4.15", + "type": "uuid" }, { - "description": "max iops of the compute offering", + "description": "the Root disk size in GB.", "length": 255, - "name": "maxiops", + "name": "rootdisksize", "required": false, - "since": "4.4", + "since": "4.15", "type": "long" }, { - "description": "The minimum memory size of the custom service offering in MB", + "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": "minmemory", + "name": "cpuspeed", "required": false, - "since": "4.13", "type": "integer" }, { - "description": "the name of the service offering", - "length": 255, - "name": "name", - "required": true, - "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", + "description": "min iops of the compute offering", "length": 255, - "name": "diskofferingstrictness", + "name": "miniops", "required": false, - "since": "4.17", - "type": "boolean" + "since": "4.4", + "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": "Whether to cleanup instance and its associated resource from database upon expunge of the instance", @@ -116778,36 +117487,45 @@ "type": "boolean" }, { - "description": "Whether to enable GPU display for this service offering. This is applicable only when passed with vGPU profile. Defaults to false.", + "description": "VMs using this offering require root volume encryption", "length": 255, - "name": "gpudisplay", + "name": "encryptroot", "required": false, - "since": "4.21", + "since": "4.18", "type": "boolean" }, { - "description": "the CPU number of the service offering", + "description": "the ID of the containing domain(s), null for public offerings", "length": 255, - "name": "cpunumber", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "integer" + "type": "list" }, { - "description": "io requests write rate of the disk offering", + "description": "burst io requests write rate of the disk offering", "length": 255, - "name": "iopswriterate", + "name": "iopswriteratemax", "required": false, "type": "long" }, { - "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "length": 255, + "name": "dynamicscalingenabled", + "required": false, + "since": "4.16", + "type": "boolean" + }, { "description": "burst bytes read rate of the disk offering", "length": 255, @@ -116816,109 +117534,132 @@ "type": "long" }, { - "description": "burst bytes write rate of the disk offering", + "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": "byteswriteratemax", + "name": "gpudisplay", "required": false, - "type": "long" + "since": "4.21", + "type": "boolean" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "the host tag for this service offering.", "length": 255, - "name": "leaseexpiryaction", + "name": "hosttags", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "Hypervisor snapshot reserve space as a percent of a volume (for managed storage using Xen or VMware)", + "description": "length (in seconds) of the burst", "length": 255, - "name": "hypervisorsnapshotreserve", + "name": "byteswriteratemaxlength", "required": false, - "since": "4.4", - "type": "integer" + "type": "long" }, { - "description": "the total memory of the service offering in MB", + "description": "length (in seconds) of the burst", "length": 255, - "name": "memory", + "name": "iopsreadratemaxlength", "required": false, - "type": "integer" + "type": "long" }, { - "description": "details for planner, used to store specific parameters", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "serviceofferingdetails", + "name": "externaldetails", "required": false, + "since": "4.21.0", "type": "map" }, { - "description": "The minimum number of CPUs to be set with Custom Computer Offering", + "description": "The minimum memory size of the custom service offering in MB", "length": 255, - "name": "mincpunumber", + "name": "minmemory", "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", + "description": "the CPU number of the service offering", "length": 255, - "name": "networkrate", + "name": "cpunumber", "required": false, "type": "integer" }, { - "description": "length (in seconds) of the burst", + "description": "burst requests read rate of the disk offering", "length": 255, - "name": "iopsreadratemaxlength", + "name": "iopsreadratemax", "required": false, "type": "long" }, { - "description": "The display text of the service offering, defaults to 'name'.", + "description": "is this a system vm offering", "length": 255, - "name": "displaytext", + "name": "issystem", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", "length": 255, - "name": "externaldetails", + "name": "provisioningtype", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "min iops of the compute offering", + "description": "the name of the service offering", "length": 255, - "name": "miniops", - "required": false, - "since": "4.4", - "type": "long" + "name": "name", + "required": true, + "type": "string" } ], "related": "updateServiceOffering,listServiceOfferings", "response": [ + { + "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": "the tags for the service offering", "name": "storagetags", "type": "string" }, + { + "description": "state of the service offering", + "name": "state", + "type": "string" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { "description": "name of the disk offering", @@ -116926,240 +117667,210 @@ "type": "string" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "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": "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", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "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": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" + "description": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, { - "description": "the id of the service offering", - "name": "id", - "type": "string" + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", + "type": "string" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "type": "long" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "is true if the offering is customized", + "name": "iscustomized", + "type": "boolean" }, {}, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", "type": "long" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "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": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "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 storage type for this service offering", - "name": "storagetype", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", - "type": "long" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", - "type": "boolean" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", "type": "boolean" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", "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", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the ID of the disk offering to which service offering is linked", - "name": "diskofferingid", - "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": "whether GPU device is used for display or not ", - "name": "gpudisplay", + "description": "the ha support in the service offering", + "name": "offerha", "type": "boolean" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "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": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "is this a system vm offering", + "name": "issystem", + "type": "boolean" + }, + { + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", - "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": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", - "type": "boolean" + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", + "type": "string" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { "description": "Instance lease duration (in days) for service offering", @@ -117167,74 +117878,79 @@ "type": "integer" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the storage type for this service offering", + "name": "storagetype", "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": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, + {}, { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", "type": "string" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", + "type": "long" }, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", "type": "integer" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" }, - {}, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", + "type": "boolean" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", - "type": "long" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, { - "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 memory in MB", + "name": "memory", + "type": "integer" }, { - "description": "state of the service offering", - "name": "state", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" } ] @@ -117245,119 +117961,139 @@ "name": "assignVirtualMachine", "params": [ { - "description": "an optional project for the new VM owner.", + "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.", "length": 255, - "name": "projectid", + "name": "securitygroupids", "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "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" }, { - "description": "id of the VM to be moved", + "description": "an optional project for the new VM owner.", "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, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "domain id of the new VM owner.", + "description": "id of the VM to be moved", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", - "required": false, + "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,createVMFromBackup,importVm", + "required": true, "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.", + "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": "securitygroupids", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork,listPaloAltoFirewallNetworks", "required": false, "type": "list" }, { - "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" } ], - "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", + "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,createVMFromBackup,importVm", "response": [ { - "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 vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "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", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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 name of the host for the virtual machine", - "name": "hostname", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the name of userdata used for the VM", + "name": "userdataname", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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 updated last time", - "name": "lastupdated", - "type": "date" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { "description": "the group ID of the virtual machine", @@ -117365,9 +118101,14 @@ "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 ID of the availability zone for the virtual machine", + "name": "zoneid", + "type": "string" }, { "description": "Vm details in key/value pairs.", @@ -117375,8 +118116,73 @@ "type": "map" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "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 project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "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": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { @@ -117385,24 +118191,29 @@ "type": "string" }, { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "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", @@ -117410,23 +118221,54 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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": "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 id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "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", + "type": "string" + }, + { + "description": "the name of the host for the virtual machine", + "name": "hostname", + "type": "string" + }, + {}, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { @@ -117435,141 +118277,133 @@ "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", "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 amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" + }, { "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": "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 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": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "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": "the domain name of the affinity group", - "name": "domain", - "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": "the description of the affinity group", - "name": "description", - "type": "string" - } - ], - "type": "set" + "description": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "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", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" + }, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "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 name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { @@ -117578,18 +118412,28 @@ "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "the password (if exists) of the virtual machine", + "name": "password", + "type": "string" + }, + { + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { @@ -117597,53 +118441,53 @@ "name": "tags", "response": [ { - "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": "tag value", + "name": "value", "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": "id of the resource", + "name": "resourceid", "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": "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" }, { - "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": "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" }, { @@ -117655,122 +118499,108 @@ "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": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Guest vm Boot Mode", + "name": "bootmode", "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": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "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 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", - "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 NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "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 gateway of the nic", + "name": "gateway", + "type": "string" + }, { "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": "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": "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 ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { @@ -117779,38 +118609,28 @@ "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", + "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 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 vpc to which the nic belongs", + "name": "vpcid", "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": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" - }, - { - "description": "the type of the nic", - "name": "type", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -117818,152 +118638,68 @@ "name": "networkid", "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": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the name of the corresponding network", + "name": "networkname", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" } ], "type": "set" }, { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "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", "type": "string" }, + {}, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "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", - "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": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", - "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 password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -117972,119 +118708,22 @@ "type": "integer" }, { - "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 VM's primary IP address", - "name": "ipaddress", - "type": "string" - }, - { - "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": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "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": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "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 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": "Guest vm Boot Mode", - "name": "bootmode", - "type": "string" - }, - { - "description": "ssh key-pairs", - "name": "keypairs", + "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 virtual machine", - "name": "id", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, - {}, - { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "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": "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 domain name of the security group", - "name": "domain", - "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 id of the security group rule", @@ -118097,8 +118736,23 @@ "type": "string" }, { - "description": "the code for the ICMP message response", - "name": "icmpcode", + "description": "security group name", + "name": "securitygroupname", + "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 type of the ICMP message response", + "name": "icmptype", "type": "integer" }, { @@ -118106,18 +118760,33 @@ "name": "account", "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": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "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 domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -118126,18 +118795,18 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "resource type", + "name": "resourcetype", "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -118146,13 +118815,8 @@ "type": "string" }, { - "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" }, { @@ -118167,76 +118831,96 @@ } ], "type": "set" - }, - { - "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" - }, - { - "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" } ], "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": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" + }, + { + "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 number of virtualmachines associated with this securitygroup", "name": "virtualmachinecount", "type": "integer" }, { - "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 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 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": "account owning the security group rule", + "name": "account", "type": "string" }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" + }, { "description": "security group name", "name": "securitygroupname", "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", - "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": "tag value", - "name": "value", + "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" }, { @@ -118245,28 +118929,28 @@ "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": "customer associated with the tag", + "name": "customer", "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -118280,8 +118964,8 @@ "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" } ], @@ -118292,46 +118976,31 @@ "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 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" } ], "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": "customer associated with the tag", - "name": "customer", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -118340,38 +119009,38 @@ "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag key name", - "name": "key", + "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": "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": "tag key name", + "name": "key", "type": "string" }, { @@ -118387,68 +119056,115 @@ "name": "virtualmachineids", "type": "set" }, + { + "description": "the project name of the group", + "name": "project", + "type": "string" + }, { "description": "the ID of the security group", "name": "id", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" + }, + { + "description": "the state of the virtual machine", + "name": "state", + "type": "string" + }, + { + "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": "list of affinity groups associated with the virtual machine", + "name": "affinitygroup", + "response": [ { - "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 description of the security group", + "description": "the description of the affinity group", "name": "description", "type": "string" }, { - "description": "the project id of the group", - "name": "projectid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the domain ID of the security group", + "description": "the domain ID of the affinity group", "name": "domainid", "type": "string" }, { - "description": "the project name of the group", + "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": "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": "the project ID of the affinity group", + "name": "projectid", + "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" } ], "type": "set" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", - "type": "string" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" - }, - { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", - "type": "string" - }, - { - "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "3.0.0" @@ -118459,11 +119175,11 @@ "name": "listVmsForImport", "params": [ { - "description": "hypervisor type of the host", + "description": "", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "the zone ID", @@ -118474,228 +119190,245 @@ "type": "uuid" }, { - "description": "the password for the host", + "description": "the host name or IP address", "length": 255, - "name": "password", - "required": false, + "name": "host", + "required": true, "type": "string" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "the host name or IP address", + "description": "the password for the host", "length": 255, - "name": "host", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "the username for the host", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "hypervisor type of the host", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "List by keyword", + "description": "the username for the host", "length": 255, - "name": "keyword", + "name": "username", "required": false, "type": "string" } ], "related": "listVmwareDcVms,listUnmanagedInstances", "response": [ - {}, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", "type": "integer" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" }, { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { - "description": "indicates the boot type", - "name": "boottype", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", - "type": "string" + "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", + "description": "the list of disks associated with the virtual machine", + "name": "disk", "response": [ { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the position of the disk", + "name": "position", + "type": "integer" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "the gateway of the nic", - "name": "gateway", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the operating system of the virtual machine", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "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 nics associated with the virtual machine", + "name": "nic", + "response": [ { "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 isolation uri of the nic", "name": "isolationuri", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "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": "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", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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 traffic type of the nic", - "name": "traffictype", + "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { @@ -118704,123 +119437,106 @@ "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 Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "description": "the capacity of the disk in bytes", - "name": "capacity", - "type": "long" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "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 ID of the corresponding network", + "name": "networkid", "type": "string" + }, + { + "description": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" } ], "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", + "description": "the CPU speed of the virtual machine", + "name": "cpuspeed", "type": "integer" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "description": "indicates the boot mode", + "name": "bootmode", "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": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" }, { - "description": "indicates the boot mode", - "name": "bootmode", + "description": "the operating system ID of the virtual machine", + "name": "osid", "type": "string" }, {} @@ -118840,12 +119556,11 @@ "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.", + "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": "capacity of the device, Capacity will be interpreted as number of networks device can handle", @@ -118855,11 +119570,12 @@ "type": "long" }, { - "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": "Netscaler load balancer device ID", @@ -118873,29 +119589,33 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter,deployNetscalerVpx", "response": [ { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "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": "the private interface of the load balancer", - "name": "privateinterface", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "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": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -118904,45 +119624,41 @@ "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "device state", + "name": "lbdevicestate", "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": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, + {}, { - "description": "device name", - "name": "lbdevicename", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "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" + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" }, { "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", @@ -118955,9 +119671,9 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" } ] }, @@ -118983,21 +119699,21 @@ } ], "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", @@ -119013,11 +119729,12 @@ "name": "addObjectStoragePool", "params": [ { - "description": "the object store provider name", + "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", "length": 255, - "name": "provider", - "required": true, - "type": "string" + "name": "size", + "required": false, + "since": "4.21", + "type": "long" }, { "description": "the name for the object store", @@ -119027,10 +119744,17 @@ "type": "string" }, { - "description": "the tags for the storage pool", + "description": "the object store provider name", "length": 255, - "name": "tags", - "required": false, + "name": "provider", + "required": true, + "type": "string" + }, + { + "description": "the URL for the object store", + "length": 2048, + "name": "url", + "required": true, "type": "string" }, { @@ -119041,18 +119765,10 @@ "type": "map" }, { - "description": "the total size of the object store in GiB. Used for tracking capacity and sending alerts", + "description": "the tags for the storage pool", "length": 255, - "name": "size", + "name": "tags", "required": false, - "since": "4.21", - "type": "long" - }, - { - "description": "the URL for the object store", - "length": 2048, - "name": "url", - "required": true, "type": "string" } ], @@ -119060,55 +119776,55 @@ "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the object store currently used size", - "name": "storageused", - "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 name of the object store", + "name": "name", + "type": "string" }, { "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 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", + "type": "long" + }, { "description": "the allocated size of the object store", "name": "storageallocated", "type": "long" }, { - "description": "the name of the object store", - "name": "name", + "description": "the provider name of the object store", + "name": "providername", + "type": "string" + }, + { + "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.19.0" @@ -119119,39 +119835,39 @@ "name": "deleteUserFromProject", "params": [ { - "description": "Id of the user to be removed from the project", + "description": "ID of the project to remove the user from", "length": 255, - "name": "userid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "projectid", + "related": "", "required": true, "type": "uuid" }, { - "description": "ID of the project to remove the user from", + "description": "Id of the user to be removed from the project", "length": 255, - "name": "projectid", - "related": "", + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", "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": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {}, { "description": "the current status of the latest async job acting on this object", @@ -119177,9 +119893,9 @@ ], "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" }, {}, { @@ -119187,17 +119903,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" - } + {} ], "since": "3.0.0" }, @@ -119214,11 +119930,11 @@ "type": "integer" }, { - "description": "", + "description": "parameters for network device", "length": 255, - "name": "page", + "name": "networkdeviceparameterlist", "required": false, - "type": "integer" + "type": "map" }, { "description": "List by keyword", @@ -119228,18 +119944,18 @@ "type": "string" }, { - "description": "Network device type, now supports ExternalDhcp, PxeServer, NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer, F5BigIpLoadBalancer, JuniperSRXFirewall, PaloAltoFirewall", + "description": "", "length": 255, - "name": "networkdevicetype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "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" } ], "related": "addNetworkDevice", @@ -119269,34 +119985,34 @@ "name": "listProjectRoles", "params": [ { - "description": "List project role by project role ID.", + "description": "List project role by project ID.", "length": 255, - "name": "projectroleid", - "related": "listProjectRoles,updateProjectRole", - "required": false, + "name": "projectid", + "related": "", + "required": true, "type": "uuid" }, { - "description": "List project role by project role name.", + "description": "List by keyword", "length": 255, - "name": "name", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List project role by project role ID.", "length": 255, - "name": "page", + "name": "projectroleid", + "related": "listProjectRoles,updateProjectRole", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List project role by project ID.", + "description": "List project role by project role name.", "length": 255, - "name": "projectid", - "related": "", - "required": true, - "type": "uuid" + "name": "name", + "required": false, + "type": "string" }, { "description": "", @@ -119306,23 +120022,18 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "updateProjectRole", "response": [ { - "description": "the id of the project", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the role", + "name": "description", "type": "string" }, { @@ -119330,28 +120041,33 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, { "description": "the name of the role", "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 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" }, @@ -119372,39 +120088,39 @@ "related": "", "response": [ { - "description": "the username to authenticate to the controller", - "name": "username", + "description": "the physical network to which this controller 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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the physical network to which this controller belongs to", - "name": "physicalnetworkid", + "description": "the name assigned to the controller", + "name": "name", "type": "string" }, - {}, { "description": "the url of the controller api", "name": "url", "type": "string" }, { - "description": "device id of the controller", - "name": "id", + "description": "the username to authenticate to the controller", + "name": "username", "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 assigned to the controller", - "name": "name", + "description": "device id of the controller", + "name": "id", "type": "string" }, {} @@ -119423,18 +120139,32 @@ "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "sshkeyenabled", + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" + }, + { + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, + "name": "bootable", "required": false, "type": "boolean" }, { - "description": "indicates that the template can be used for deployment of CKS clusters", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "forcks", + "name": "isrouting", + "required": false, + "type": "boolean" + }, + { + "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, - "since": "4.21.0", "type": "boolean" }, { @@ -119449,51 +120179,52 @@ "description": "the ID of the image file", "length": 255, "name": "id", - "related": "listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,updateTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": true, "type": "uuid" }, { - "description": "sort key of the template, integer", + "description": "the tag for this template.", "length": 255, - "name": "sortkey", + "name": "templatetag", "required": false, - "type": "integer" + "since": "4.20.0", + "type": "string" }, { - "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "details", + "name": "templatetype", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "isdynamicallyscalable", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "Details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "isrouting", + "name": "details", "required": false, - "type": "boolean" + "type": "map" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "the name of the image file", "length": 255, - "name": "requireshvm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the format for the image", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "format", + "name": "isdynamicallyscalable", "required": false, - "type": "string" + "type": "boolean" }, { "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.", @@ -119504,151 +120235,64 @@ "type": "boolean" }, { - "description": "the tag for this template.", - "length": 255, - "name": "templatetag", - "required": false, - "since": "4.20.0", - "type": "string" - }, - { - "description": "true if the image supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" - }, - { - "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": "indicates that the template can be used for deployment of CKS clusters", "length": 255, - "name": "cleanupdetails", + "name": "forcks", "required": false, + "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 format for the image", "length": 255, - "name": "templatetype", + "name": "format", "required": false, "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "bootable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "arch", + "name": "passwordenabled", "required": false, - "since": "4.20", - "type": "string" + "type": "boolean" }, { - "description": "the name of the image file", + "description": "sort key of the template, integer", "length": 255, - "name": "name", + "name": "sortkey", "required": false, - "type": "string" + "type": "integer" } ], - "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ - {}, { - "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": "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": "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": "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": "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": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" - }, - { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "the name of the OS type for this template.", - "name": "ostypename", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { "description": "path of the Domain the template belongs to", @@ -119656,49 +120300,39 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", - "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", + "name": "jobstatus", + "type": "integer" }, { - "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" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, + {}, { - "description": "the template ID", - "name": "id", - "type": "string" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the account id to which the template belongs", + "name": "accountid", "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" }, { @@ -119707,34 +120341,40 @@ "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 template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" + "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": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" + "description": "the project id of the template", + "name": "projectid", + "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the template display text", + "name": "displaytext", + "type": "string" + }, + { + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "the tag of this template", @@ -119742,28 +120382,23 @@ "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "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 physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -119772,8 +120407,8 @@ "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -119782,135 +120417,216 @@ "type": "date" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", - "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 name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of userdata linked to this template", + "name": "userdataid", + "type": "string" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "additional key/value details tied with template", + "name": "details", + "type": "map" }, { - "description": "the template name", - "name": "name", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "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 featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "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" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "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 project id the tag belongs to", + "name": "projectid", + "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": "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" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the name of the secondary storage host for the template", + "name": "hostname", + "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "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 size of the template", + "name": "size", + "type": "long" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "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 id of userdata linked to this template", - "name": "userdataid", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "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": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" + }, + { + "description": "checksum of the template", + "name": "checksum", + "type": "string" } ] }, @@ -119920,78 +120636,63 @@ "name": "createVlanIpRange", "params": [ { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, - { - "description": "the gateway of the VLAN IP range", + "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": "gateway", + "name": "vlan", "required": false, "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "domain ID of the account owning a VLAN", "length": 255, - "name": "forsystemvms", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ending 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": "endipv6", + "name": "account", "required": false, "type": "string" }, { - "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, - { - "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "projectid", - "related": "", + "name": "netmask", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", + "description": "true if IP range is set to system vms, false if not", "length": 255, - "name": "ip6gateway", + "name": "forsystemvms", "required": false, - "type": "string" + "type": "boolean" }, { - "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": "domain ID of the account owning a VLAN", + "description": "optional parameter. Have to be specified for Direct Untagged vlan only.", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the Zone ID of the VLAN IP range", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "startip", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the network id", @@ -120002,9 +120703,9 @@ "type": "uuid" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "endip", + "name": "endipv6", "required": false, "type": "string" }, @@ -120016,55 +120717,70 @@ "type": "boolean" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "endip", "required": false, "type": "string" }, { - "description": "Provider name for which the IP range is reserved for", + "description": "the gateway of the IPv6 network. Required for Shared networks and Isolated networks when it belongs to VPC", "length": 255, - "name": "provider", + "name": "ip6gateway", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the physical network id", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "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 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": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "vlan", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "ip6cidr", + "name": "startipv6", "required": false, "type": "string" }, { - "description": "the physical network id", + "description": "project who will own the VLAN. If VLAN is Zone wide, this parameter should be omitted", "length": 255, - "name": "physicalnetworkid", + "name": "projectid", "related": "", "required": false, "type": "uuid" + }, + { + "description": "the gateway of the VLAN IP range", + "length": 255, + "name": "gateway", + "required": false, + "type": "string" } ], "related": "updateVlanIpRange", "response": [ { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { @@ -120073,13 +120789,14 @@ "type": "integer" }, { - "description": "the cidr of the VLAN IP range", - "name": "cidr", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { @@ -120088,8 +120805,8 @@ "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" }, { @@ -120108,19 +120825,8 @@ "type": "string" }, { - "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", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { @@ -120129,33 +120835,33 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", + "description": "the description of the VLAN IP range", + "name": "description", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "description": "the domain name of the VLAN IP range", + "name": "domain", "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 domain ID of the VLAN IP range", - "name": "domainid", + "description": "indicates to which provider the IP range is dedicated to", + "name": "provider", "type": "string" }, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the start ip of the VLAN IP range", + "name": "startip", "type": "string" }, { @@ -120163,47 +120869,57 @@ "name": "endip", "type": "string" }, - { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "string" - }, { "description": "indicates whether VLAN IP range is dedicated to system vms or not", "name": "forsystemvms", "type": "boolean" }, { - "description": "the netmask of the VLAN IP range", - "name": "netmask", + "description": "the gateway of the VLAN IP range", + "name": "gateway", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "description": "the project id of the vlan range", + "name": "projectid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, + {}, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, - {} + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", + "type": "string" + }, + { + "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" + } ] }, { @@ -120211,14 +120927,6 @@ "isasync": true, "name": "updateVpnConnection", "params": [ - { - "description": "id of vpn connection", - "length": 255, - "name": "id", - "related": "updateVpnConnection", - "required": true, - "type": "uuid" - }, { "description": "an optional field, whether to the display the vpn to the end user or not", "length": 255, @@ -120227,6 +120935,14 @@ "since": "4.4", "type": "boolean" }, + { + "description": "id of vpn connection", + "length": 255, + "name": "id", + "related": "updateVpnConnection", + "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, @@ -120239,65 +120955,65 @@ "related": "", "response": [ { - "description": "the project id", - "name": "projectid", + "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", "type": "string" }, { - "description": "the owner", - "name": "account", - "type": "string" + "description": "if DPD is enabled for customer gateway", + "name": "dpd", + "type": "boolean" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date and time the host was created", + "name": "created", + "type": "date" }, { - "description": "Split multiple remote networks into multiple phase 2 SAs. Often used with Cisco some products.", - "name": "splitconnections", - "type": "boolean" + "description": "the connection ID", + "name": "id", + "type": "string" }, { - "description": "if Force NAT Encapsulation is enabled for customer gateway", - "name": "forceencap", - "type": "boolean" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the domain path of the owner", + "name": "domainpath", "type": "string" }, { - "description": "Lifetime of IKE SA of customer gateway", - "name": "ikelifetime", - "type": "long" + "description": "the owner", + "name": "account", + "type": "string" }, { - "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": "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": "public ip address id of the customer gateway", - "name": "gateway", + "description": "the project id", + "name": "projectid", "type": "string" }, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "IKE policy of the customer gateway", + "name": "ikepolicy", "type": "string" }, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", + "name": "ikeversion", + "type": "string" }, { "description": "the vpn gateway ID", @@ -120305,8 +121021,8 @@ "type": "string" }, { - "description": "Which IKE Version to use, one of ike (autoselect), ikev1, or ikev2. Defaults to ike", - "name": "ikeversion", + "description": "ESP policy of the customer gateway", + "name": "esppolicy", "type": "string" }, { @@ -120315,30 +121031,29 @@ "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "IPsec Preshared-Key of the customer gateway", + "name": "ipsecpsk", + "type": "string" }, { - "description": "is connection for display to the regular user", - "name": "fordisplay", + "description": "State of vpn connection", + "name": "passive", "type": "boolean" }, - {}, { "description": "Lifetime of ESP SA of customer gateway", "name": "esplifetime", "type": "long" }, { - "description": "guest cidr list of the customer gateway. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "if DPD is enabled for customer gateway", - "name": "dpd", - "type": "boolean" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { "description": "the public IP address", @@ -120346,9 +121061,14 @@ "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": "is connection for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "State of vpn connection", @@ -120360,25 +121080,21 @@ "name": "s2scustomergatewayid", "type": "string" }, + {}, { - "description": "IPsec Preshared-Key of the customer gateway", - "name": "ipsecpsk", + "description": "public ip address id of the customer gateway", + "name": "gateway", "type": "string" }, { - "description": "IKE policy of the customer gateway", - "name": "ikepolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "ESP policy of the customer gateway", - "name": "esppolicy", + "description": "the domain name of the owner", + "name": "domain", "type": "string" - }, - { - "description": "State of vpn connection", - "name": "passive", - "type": "boolean" } ], "since": "4.4" @@ -120388,14 +121104,6 @@ "isasync": false, "name": "listPaloAltoFirewallNetworks", "params": [ - { - "description": "palo alto balancer device ID", - "length": 255, - "name": "lbdeviceid", - "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", - "required": true, - "type": "uuid" - }, { "description": "List by keyword", "length": 255, @@ -120416,29 +121124,43 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "palo alto balancer device ID", + "length": 255, + "name": "lbdeviceid", + "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", + "required": true, + "type": "uuid" } ], "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ + {}, { - "description": "the traffic type of the network", - "name": "traffictype", - "type": "string" - }, - { - "description": "the id of the network", - "name": "id", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { "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 domain associated with the tag", + "name": "domain", + "type": "string" + }, { "description": "the ID of the domain associated with the tag", "name": "domainid", @@ -120449,19 +121171,14 @@ "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", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -120470,153 +121187,77 @@ "type": "string" }, { - "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 account associated with the tag", - "name": "account", + "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 value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "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": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "state of the network provider", - "name": "state", - "type": "string" - }, - { - "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": "the physical network this belongs to", - "name": "physicalnetworkid", - "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" - } - ], - "type": "list" + "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 external id of the network", - "name": "externalid", + "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 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": "the owner of the network", - "name": "account", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { "description": "true if network supports specifying ip ranges, false otherwise", @@ -120624,28 +121265,38 @@ "type": "boolean" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "If a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" + }, + { + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", "type": "boolean" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The external id of the network", + "name": "externalid", "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "state of the network", + "name": "state", "type": "string" }, { @@ -120653,130 +121304,202 @@ "name": "issystem", "type": "boolean" }, + {}, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", + "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project name of the address", + "name": "project", + "type": "string" }, { - "description": "MTU configured on the network VR's private interfaces", - "name": "privatemtu", - "type": "integer" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "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 internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", - "type": "string" + "description": "true if network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "state of the network", - "name": "state", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "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": "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" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + }, + { + "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", + "type": "string" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + }, + { + "description": "the provider name", + "name": "name", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + } + ], + "type": "list" + } + ], + "type": "list" + }, + { + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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", + "name": "id", + "type": "string" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, { "description": "list networks available for vm deployment", @@ -120784,165 +121507,158 @@ "type": "boolean" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "The BGP peers for the network", - "name": "bgppeers", - "type": "set" + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", + "type": "boolean" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "VPC the network belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", - "type": "string" + "description": "the date this network was created", + "name": "created", + "type": "date" }, { - "description": "the network's netmask", - "name": "netmask", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" + "description": "the physical network id", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "type": "boolean" + "description": "ACL Id associated with the VPC network", + "name": "aclid", + "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 VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, - {}, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", - "type": "boolean" + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", + "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 name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "the name of the network", - "name": "name", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" - }, - { - "description": "the type of the network", - "name": "type", - "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 routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "VPC the network belongs to", - "name": "vpcid", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", - "type": "string" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" } ] @@ -120962,12 +121678,6 @@ ], "related": "", "response": [ - { - "description": "The path field for the volume", - "name": "path", - "type": "string" - }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -120978,6 +121688,12 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "The path field for the volume", + "name": "path", + "type": "string" + }, {} ] }, @@ -120986,6 +121702,13 @@ "isasync": false, "name": "listManagementServers", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the id of the management server", "length": 255, @@ -120994,6 +121717,13 @@ "required": false, "type": "uuid" }, + { + "description": "the name of the management server", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "Whether to return the management server peers or not. By default, the management server peers will not be returned.", "length": 255, @@ -121009,20 +121739,6 @@ "required": false, "type": "integer" }, - { - "description": "the name of the management server", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "List by keyword", "length": 255, @@ -121033,75 +121749,86 @@ ], "related": "", "response": [ - {}, { - "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", - "name": "lastagents", - "type": "list" + "description": "the name of the OS distribution running on the management server", + "name": "osdistribution", + "type": "string" }, + {}, { - "description": "the version of the java distribution running the management server process", - "name": "javaversion", + "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 state of the management server", + "name": "state", + "type": "state" + }, { "description": "the last time this Management Server was started", "name": "lastserverstart", "type": "date" }, { - "description": "the agents this Management Server is responsible for", - "name": "agents", + "description": "the Management Server Peers", + "name": "peers", "type": "list" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "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 IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", + "name": "serviceip", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of the management server", + "name": "version", "type": "string" }, { - "description": "the ID of the management server", - "name": "id", + "description": "the version of the java distribution running the management server process", + "name": "javaversion", "type": "string" }, { - "description": "the Management Server Peers", - "name": "peers", + "description": "the agents this Management Server is responsible for", + "name": "agents", "type": "list" }, { - "description": "the state of the management server", - "name": "state", - "type": "state" + "description": "the number of pending jobs in this Management Server", + "name": "pendingjobscount", + "type": "long" }, { - "description": "the name of the management server", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the running OS kernel version for this Management Server", - "name": "kernelversion", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the IP Address for this Management Server. This is deprecated, please use 'ipaddress' instead.", - "name": "serviceip", + "description": "the last time the host on which this Management Server runs was booted", + "name": "lastboottime", + "type": "date" + }, + { + "description": "the name of the management server", + "name": "name", "type": "string" }, { @@ -121110,30 +121837,19 @@ "type": "string" }, { - "description": "the java distribution name running the management server process", - "name": "javadistribution", + "description": "the ID of the management server", + "name": "id", "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", + "description": "the running OS kernel version for this Management Server", + "name": "kernelversion", "type": "string" }, { - "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" + "description": "the last agents this Management Server is responsible for, before shutdown or preparing for maintenance", + "name": "lastagents", + "type": "list" } ] }, @@ -121142,6 +121858,14 @@ "isasync": false, "name": "listTungstenFabricPolicyRule", "params": [ + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "description": "the uuid of Tungsten-Fabric policy", "length": 255, @@ -121164,24 +121888,16 @@ "type": "integer" }, { - "description": "the uuid of Tungsten-Fabric rule", + "description": "List by keyword", "length": 255, - "name": "ruleuuid", + "name": "keyword", "required": false, "type": "string" }, { - "description": "the ID of zone", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the uuid of Tungsten-Fabric rule", "length": 255, - "name": "keyword", + "name": "ruleuuid", "required": false, "type": "string" } @@ -121189,101 +121905,101 @@ "related": "addTungstenFabricPolicyRule", "response": [ { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", + "description": "Tungsten-Fabric policy source end port", + "name": "srcendport", "type": "int" }, + {}, { "description": "Tungsten-Fabric provider zone id", "name": "zoneid", "type": "long" }, { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", "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 policy destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" }, + {}, { "description": "Tungsten-Fabric rule uuid", "name": "uuid", "type": "string" }, - {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "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 policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", "type": "int" }, - {}, { - "description": "Tungsten-Fabric policy name", - "name": "direction", + "description": "Tungsten-Fabric policy destination network", + "name": "destnetwork", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", + "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": "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" } ] }, @@ -121309,23 +122025,23 @@ } ], "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", @@ -121357,67 +122073,67 @@ "related": "", "response": [ { - "description": "the account owning the instance group", - "name": "account", + "description": "path of the Domain the instance group belongs to", + "name": "domainpath", "type": "string" }, - {}, { - "description": "the domain ID of the instance group", - "name": "domainid", + "description": "the name of the instance group", + "name": "name", "type": "string" }, { - "description": "time and date the instance group was created", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the instance group", - "name": "project", + "description": "the account owning the instance group", + "name": "account", "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" }, { - "description": "the domain name of the instance group", - "name": "domain", + "description": "the domain ID of the instance group", + "name": "domainid", "type": "string" }, { - "description": "path of the Domain the instance group belongs to", - "name": "domainpath", - "type": "string" + "description": "time and date the instance group was created", + "name": "created", + "type": "date" }, { "description": "the project ID of the instance group", "name": "projectid", "type": "string" }, + { + "description": "the ID of the instance group", + "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 instance group", - "name": "id", + "description": "the domain name of the instance group", + "name": "domain", "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 project name of the instance group", + "name": "project", + "type": "string" + }, + {} ] }, { @@ -121426,11 +122142,19 @@ "name": "listTemplateDirectDownloadCertificates", "params": [ { - "description": "if set to true: include the hosts where the certificate is uploaded to", + "description": "", "length": 255, - "name": "listhosts", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" + }, + { + "description": "list direct download certificate by ID", + "length": 255, + "name": "id", + "related": "listTemplateDirectDownloadCertificates", + "required": false, + "type": "uuid" }, { "description": "List by keyword", @@ -121442,18 +122166,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "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, @@ -121463,24 +122179,35 @@ "type": "uuid" }, { - "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" } ], "related": "", "response": [ + {}, + { + "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", "type": "string" }, { - "description": "the hosts where the certificate is uploaded to", - "name": "hostsmap", - "type": "list" + "description": "the direct download certificate subject", + "name": "subject", + "type": "string" + }, + { + "description": "the direct download certificate alias", + "name": "alias", + "type": "string" }, { "description": "the direct download certificate version", @@ -121488,8 +122215,8 @@ "type": "string" }, { - "description": "the hypervisor of the hosts where the certificate is uploaded", - "name": "hypervisor", + "description": "the direct download certificate issuer", + "name": "validity", "type": "string" }, { @@ -121503,23 +122230,13 @@ "type": "integer" }, { - "description": "the direct download certificate subject", - "name": "subject", - "type": "string" - }, - { - "description": "the direct download certificate issuer", - "name": "validity", - "type": "string" - }, - { - "description": "the zone id where the certificate is uploaded", - "name": "zoneid", - "type": "string" + "description": "the hosts where the certificate is uploaded to", + "name": "hostsmap", + "type": "list" }, { - "description": "the direct download certificate alias", - "name": "alias", + "description": "the zone name where the certificate is uploaded", + "name": "zonename", "type": "string" }, { @@ -121528,16 +122245,15 @@ "type": "string" }, { - "description": "the zone name where the certificate is uploaded", - "name": "zonename", + "description": "the direct download certificate serial num", + "name": "serialnum", "type": "string" }, { - "description": "the direct download certificate serial num", - "name": "serialnum", + "description": "the zone id where the certificate is uploaded", + "name": "zoneid", "type": "string" }, - {}, {} ], "since": "4.17.0" @@ -121592,6 +122308,8 @@ "name": "url", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -121602,7 +122320,6 @@ "name": "name", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -121617,8 +122334,7 @@ "description": "the zone ID of ucs manager", "name": "zoneid", "type": "string" - }, - {} + } ] }, { @@ -121627,18 +122343,18 @@ "name": "changeServiceForRouter", "params": [ { - "description": "The ID of the router", + "description": "the service offering ID to apply to the domain router", "length": 255, - "name": "id", - "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "the service offering ID to apply to the domain router", + "description": "The ID of the router", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listRouters,changeServiceForRouter,listInternalLoadBalancerVMs", "required": true, "type": "uuid" } @@ -121646,8 +122362,84 @@ "related": "listRouters,listInternalLoadBalancerVMs", "response": [ { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "role of the domain router", + "name": "role", + "type": "string" + }, + { + "description": "the guest netmask for the router", + "name": "guestnetmask", + "type": "string" + }, + { + "description": "the account associated with the router", + "name": "account", + "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 gateway for the router", + "name": "gateway", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + {}, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "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 guest IP address for the router", + "name": "guestipaddress", + "type": "string" + }, + { + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" + }, + { + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { @@ -121655,24 +122447,74 @@ "name": "name", "type": "string" }, + { + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the template name for the router", + "name": "templatename", + "type": "string" + }, + { + "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", + "type": "string" + }, { "description": "the link local netmask for the router", "name": "linklocalnetmask", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the project id of the ipaddress", + "name": "projectid", + "type": "string" }, { - "description": "the link local MAC address for the router", - "name": "linklocalmacaddress", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the domain ID associated with the router", + "name": "domainid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { @@ -121680,78 +122522,68 @@ "name": "nic", "response": [ { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the name of the corresponding network", + "name": "networkname", "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" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", - "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": "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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 type of the nic", + "name": "type", + "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" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the ID of the nic", + "name": "id", "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", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -121759,69 +122591,64 @@ "name": "gateway", "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": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "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": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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": "the ID of the corresponding network", - "name": "networkid", + "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -121830,77 +122657,56 @@ "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": "the broadcast uri of the nic", + "name": "broadcasturi", + "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" } ], "type": "set" }, { - "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 hostname for the router", - "name": "hostname", - "type": "string" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "type": "string" - }, - { - "description": "the guest netmask for the router", - "name": "guestnetmask", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "CPU arch of the router", - "name": "arch", - "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": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the Zone name for the router", - "name": "zonename", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" - }, - { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -121909,79 +122715,8 @@ "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", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { @@ -121990,92 +122725,52 @@ "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 project id of the ipaddress", - "name": "projectid", - "type": "string" - }, - { - "description": "the Pod name for the router", - "name": "podname", - "type": "string" - }, - { - "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", + "description": "the host ID for the router", + "name": "hostid", "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", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", - "type": "string" + "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 date this VPC was created", - "name": "lastupdated", - "type": "date" + "description": "the type of the health check - basic or advanced", + "name": "checktype", + "type": "string" }, { - "description": "result of the health check", + "description": "result of the health check if available", "name": "success", "type": "boolean" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" }, { - "description": "the type of the health check - basic or advanced", - "name": "checktype", + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" + }, + { + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { @@ -122087,33 +122782,59 @@ "type": "list" }, { - "description": "the public netmask for the router", - "name": "publicnetmask", + "description": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "description": "the state of the router", + "name": "state", + "type": "state" + }, + {}, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" }, { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "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 public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" } ] @@ -122123,6 +122844,14 @@ "isasync": true, "name": "updateVolume", "params": [ + { + "description": "The chain info of the volume", + "length": 255, + "name": "chaininfo", + "required": false, + "since": "4.4", + "type": "string" + }, { "description": "The state of the volume", "length": 255, @@ -122132,46 +122861,28 @@ "type": "string" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "new name of the volume", "length": 255, - "name": "customid", + "name": "name", "required": false, - "since": "4.4", + "since": "4.16", "type": "string" }, { - "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.", + "description": "an optional field, whether to the display the volume to the end user or not.", "length": 255, - "name": "deleteprotection", + "name": "displayvolume", "required": false, - "since": "4.20.0", "type": "boolean" }, { - "description": "The chain info of the volume", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "chaininfo", + "name": "customid", "required": false, "since": "4.4", "type": "string" }, - { - "description": "new name of the volume", - "length": 255, - "name": "name", - "required": false, - "since": "4.16", - "type": "string" - }, - { - "description": "Destination storage pool UUID for the volume", - "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", - "required": false, - "since": "4.3", - "type": "uuid" - }, { "description": "the ID of the disk volume", "length": 255, @@ -122181,10 +122892,11 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the volume to the end user or not.", + "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": "displayvolume", + "name": "deleteprotection", "required": false, + "since": "4.20.0", "type": "boolean" }, { @@ -122193,29 +122905,43 @@ "name": "path", "required": false, "type": "string" + }, + { + "description": "Destination storage pool UUID for the volume", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": false, + "since": "4.3", + "type": "uuid" } ], "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume,importVolume", "response": [ { - "description": "the write (IO) of disk on the vm", - "name": "diskiowrite", - "type": "long" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "name of the virtual machine", - "name": "vmname", - "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": "size of the disk volume", - "name": "size", - "type": "long" + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" }, { "description": "the bytes allocated", @@ -122228,59 +122954,39 @@ "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", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "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": "the state of the disk volume", "name": "state", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "cluster id of the volume", + "name": "clusterid", + "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "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": "ID of the disk volume", + "name": "id", + "type": "string" }, { "description": "provisioning type used to create volumes.", @@ -122288,14 +122994,15 @@ "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": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", - "type": "long" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { "description": "id of the virtual machine", @@ -122303,58 +123010,63 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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": "pod id of the volume", - "name": "podid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "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": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", - "type": "string" + "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", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "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" }, { @@ -122363,92 +123075,113 @@ "type": "date" }, { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "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 project id of the vpn", - "name": "projectid", + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "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": "name of the availability zone", - "name": "zonename", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "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": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, + {}, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "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", + "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": "tag value", "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "resource type", + "name": "resourcetype", "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": "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 domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -122457,8 +123190,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -122470,156 +123208,139 @@ "type": "set" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "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 write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" - }, - { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" }, { - "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 date the volume was attached to a VM instance", - "name": "attached", - "type": "date" + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" }, { - "description": "ID of the disk volume", - "name": "id", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, - {}, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, { - "description": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", "type": "boolean" }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, - { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "cluster id of the volume", - "name": "clusterid", - "type": "string" - }, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", "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" }, { - "description": "name of the disk volume", - "name": "name", + "description": "true if the volume is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" + }, + { + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" } ] }, @@ -122636,11 +123357,12 @@ "type": "integer" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -122650,37 +123372,25 @@ "type": "string" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "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", + "description": "the provider name", + "name": "name", "type": "string" }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - }, { "description": "true if individual services can be enabled/disabled", "name": "canenableindividualservice", @@ -122691,20 +123401,31 @@ "name": "jobid", "type": "string" }, - {}, + { + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, + {}, { - "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", + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" } ], @@ -122716,62 +123437,62 @@ "name": "updateAccount", "params": [ { - "description": "Details for the account used to store specific parameters", + "description": "New name for the account", "length": 255, - "name": "accountdetails", + "name": "newname", "required": false, - "type": "map" + "type": "string" }, { - "description": "The UUID of the dynamic role to set for the account", + "description": "Account UUID", "length": 255, - "name": "roleid", - "related": "createRole,listRoles,updateRole", + "name": "id", + "related": "disableAccount,enableAccount,updateAccount,listAccounts", "required": false, "type": "uuid" }, { - "description": "The UUID of the domain where the account exists", + "description": "Details for the account used to store specific parameters", "length": 255, - "name": "domainid", - "related": "listDomains,listDomains", + "name": "accountdetails", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Current account name", + "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": "account", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.0", "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": "Network domain for the account's networks; empty string will update domainName with NULL value", "length": 255, - "name": "apikeyaccess", + "name": "networkdomain", "required": false, - "since": "4.20.1.0", "type": "string" }, { - "description": "New name for the account", + "description": "Current account name", "length": 255, - "name": "newname", + "name": "account", "required": false, "type": "string" }, { - "description": "Network domain for the account's networks; empty string will update domainName with NULL value", + "description": "The UUID of the domain where the account exists", "length": 255, - "name": "networkdomain", + "name": "domainid", + "related": "listDomains,listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Account UUID", + "description": "The UUID of the dynamic role to set for the account", "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,updateAccount,listAccounts", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, "type": "uuid" } @@ -122779,43 +123500,73 @@ "related": "disableAccount,enableAccount,listAccounts", "response": [ { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "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 primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", "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", + "type": "long" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "path of the Domain the account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", "type": "long" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", + "type": "string" + }, + { + "description": "the total number of networks the account can own", + "name": "networklimit", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -122823,43 +123574,43 @@ "name": "user", "response": [ { - "description": "the user firstname", - "name": "firstname", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user ID", - "name": "id", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user firstname", + "name": "firstname", + "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" + "description": "the user email address", + "name": "email", + "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "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 type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -122868,83 +123619,83 @@ "type": "resourceiconresponse" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the user email address", - "name": "email", + "description": "the user ID", + "name": "id", "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", + "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", + "description": "the user lastname", + "name": "lastname", + "type": "string" + }, + { + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user state", - "name": "state", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the ID of the role", + "name": "roleid", "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 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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain name of the user", + "name": "domain", "type": "string" } ], @@ -122952,98 +123703,113 @@ }, {}, { - "description": "the total memory (in MB) the account can own", - "name": "memorylimit", - "type": "string" + "description": "the total number of backups stored by this account", + "name": "backuptotal", + "type": "long" }, { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "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 projects being administrated by this account", + "name": "projecttotal", "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", + "description": "details for the account", + "name": "accountdetails", + "type": "map" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", "type": "string" }, { - "description": "the total volume being used by this account", - "name": "volumetotal", + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "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", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "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 object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "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 stopped for this account", + "name": "vmstopped", + "type": "integer" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", - "type": "string" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" + }, + { + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "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 number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", "type": "string" }, { @@ -123062,240 +123828,195 @@ "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", - "type": "long" - }, - { - "description": "the network domain", - "name": "networkdomain", + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of backups stored by this account", - "name": "backuptotal", - "type": "long" + "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 total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { - "description": "the total number of networks the account can own", - "name": "networklimit", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", + "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 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 backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the id of the account", - "name": "id", + "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 number of vpcs the account can own", + "name": "vpclimit", + "type": "string" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of public ip addresses available for this account to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of projects the account can own", - "name": "projectlimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" + "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 cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by account", - "name": "secondarystoragetotal", - "type": "float" - }, - { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", + "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total volume which can be used by this account", + "name": "volumelimit", "type": "string" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "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", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of acl groups that account belongs to", - "name": "groups", + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", "type": "list" }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" - }, { "description": "the total number of networks owned by account", "name": "networktotal", "type": "long" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", - "type": "long" + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the name of the account", + "name": "name", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "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" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total number of cpu cores the account can own", + "name": "cpulimit", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "name of the Domain the account belongs to", + "name": "domain", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, { "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 primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", - "type": "long" - }, - { - "description": "the ID of the role", - "name": "roleid", - "type": "string" - }, - {}, - { - "description": "the state of the account", - "name": "state", - "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": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" } ] }, @@ -123322,77 +124043,77 @@ ], "related": "listSwifts", "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 protocol of the image store", + "name": "protocol", + "type": "string" }, { "description": "the Zone name of the image store", "name": "zonename", "type": "string" }, + { + "description": "the name of the image store", + "name": "name", + "type": "string" + }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, + {}, { - "description": "defines if store is read-only", - "name": "readonly", + "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 scope of the image store", + "name": "scope", + "type": "scopetype" }, { - "description": "the ID of the image store", - "name": "id", - "type": "string" + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" }, + {}, { - "description": "the name of the image store", - "name": "name", + "description": "the ID of the image store", + "name": "id", "type": "string" }, { - "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 provider name of the image store", "name": "providername", "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 scope of the image store", - "name": "scope", - "type": "scopetype" + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ] }, @@ -123402,36 +124123,66 @@ "name": "updateVirtualMachine", "params": [ { - "description": "Number of days to lease the instance from now onward. Use -1 to remove the existing lease", + "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": "leaseduration", + "name": "deleteprotection", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.20.0", + "type": "boolean" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "instance name of the user vm", "length": 255, - "name": "userdatadetails", + "name": "instancename", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "length": 255, + "name": "details", "required": false, - "since": "4.18", "type": "map" }, { - "description": "list of security group ids to be applied on the virtual machine.", + "description": "an optional field, whether to the display the vm to the end user or not.", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "displayvm", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "Details in key/value pairs. 'extraconfig' is not allowed to be passed in details.", + "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", "length": 255, - "name": "details", + "name": "name", + "required": false, + "since": "4.4", + "type": "string" + }, + { + "description": "The ID of the virtual machine", + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + }, + { + "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": "the ID of the userdata", "length": 255, @@ -123442,33 +124193,58 @@ "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": "list of security group ids to be applied on the virtual machine.", "length": 255, - "name": "cleanupdetails", + "name": "securitygroupids", + "related": "", "required": false, - "type": "boolean" + "type": "list" }, { - "description": "group of the virtual machine", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "group", + "name": "leaseexpiryaction", "required": false, + "since": "4.21.0", "type": "string" }, { - "description": "The ID of the virtual machine", + "description": "true if high-availability is enabled for the virtual machine, false otherwise", "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" + "name": "haenable", + "required": false, + "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", + "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": "dhcpoptionsnetworklist", + "name": "securitygroupnames", + "related": "", "required": false, - "type": "map" + "type": "list" + }, + { + "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": "user generated name", + "length": 255, + "name": "displayname", + "required": false, + "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": "the ID of the OS type that best represents this VM.", @@ -123479,21 +124255,27 @@ "type": "uuid" }, { - "description": "new host name of the vm. The VM has to be stopped/started for this update to take affect", + "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": "name", + "name": "dhcpoptionsnetworklist", "required": false, - "since": "4.4", - "type": "string" + "type": "map" }, { - "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.", + "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": "deleteprotection", + "name": "cleanupdetails", "required": false, - "since": "4.20.0", "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": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, @@ -123503,84 +124285,88 @@ "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", - "length": 255, - "name": "displayvm", - "required": false, + "description": "group of the virtual machine", + "length": 255, + "name": "group", + "required": false, + "type": "string" + } + ], + "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,createVMFromBackup,importVm", + "response": [ + { + "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": "true if vm has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { - "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": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "user generated name", - "length": 255, - "name": "displayname", - "required": false, + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "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", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", - "length": 255, - "name": "leaseexpiryaction", - "required": false, - "since": "4.21.0", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "instance name of the user vm", - "length": 255, - "name": "instancename", - "required": false, - "since": "4.4", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "true if high-availability is enabled for the virtual machine, false otherwise", - "length": 255, - "name": "haenable", - "required": false, + "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. This can be updated only when dynamic scaling is enabled on template, service offering and the corresponding global setting", - "length": 255, + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", "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 id of the vm", + "name": "projectid", + "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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" }, { @@ -123589,95 +124375,427 @@ "type": "resourceiconresponse" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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": "the description of the affinity group", + "name": "description", + "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 name of the affinity group", + "name": "domain", + "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 project name of the affinity group", + "name": "project", + "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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + } + ], + "type": "set" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "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 pool type of the virtual machine", - "name": "pooltype", + "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", + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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", + "type": "long" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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": "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": "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 ID of the corresponding network", + "name": "networkid", + "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 gateway of the nic", + "name": "gateway", + "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 ID of the nic", + "name": "id", + "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": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "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": "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", + "type": "string" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" + }, { "description": "the account associated with the virtual machine", "name": "account", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", "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": "the project id of the vm", - "name": "projectid", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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 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": "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": "resource type", + "name": "resourcetype", + "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" + } + ], + "type": "set" + }, + { + "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": "list of security groups associated with the virtual machine", "name": "securitygroup", @@ -123693,67 +124811,32 @@ "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "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 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 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 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": "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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -123766,8 +124849,8 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -123776,13 +124859,8 @@ "type": "string" }, { - "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" }, { @@ -123791,13 +124869,13 @@ "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": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -123806,55 +124884,75 @@ "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": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", "type": "string" } ], "type": "set" + }, + { + "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 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": "account owning the security group rule", + "name": "account", + "type": "string" + }, + { + "description": "the type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "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 domain name of the security group", - "name": "domain", + "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 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 protocol of the security group rule", - "name": "protocol", - "type": "string" - }, { "description": "the code for the ICMP message response", "name": "icmpcode", @@ -123875,33 +124973,58 @@ "name": "account", "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 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": "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { @@ -123915,53 +125038,43 @@ "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": "tag key name", + "name": "key", "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 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 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", + "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" }, { @@ -123974,338 +125087,75 @@ "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", + "description": "resource type", + "name": "resourcetype", "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": "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", + "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" + } + ], + "type": "set" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the name of the security group", + "name": "name", "type": "string" } ], "type": "set" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "VNF details", + "name": "vnfdetails", + "type": "map" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { @@ -124314,24 +125164,24 @@ "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "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": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "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": "an alternate display text of the ISO attached to the virtual machine", @@ -124339,23 +125189,18 @@ "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "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": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { @@ -124364,369 +125209,245 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", + "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": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "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 user's name who deployed the virtual machine", - "name": "username", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", - "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", - "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": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "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 the virtual machine", - "name": "name", + "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", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "description": "the group ID of the virtual machine", + "name": "groupid", + "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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": "CPU arch of the VM", - "name": "arch", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the ID of the virtual machine", - "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": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "type": "string" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "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", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "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", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", "type": "boolean" }, { - "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 project ID of the affinity group", - "name": "projectid", - "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 project name of the affinity group", - "name": "project", - "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 type of the affinity group", - "name": "type", - "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 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": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "OS name of the vm", + "name": "osdisplayname", "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 count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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 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", - "type": "string" + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, + {}, { "description": "the target memory in VM (KiB)", "name": "memorytargetkbs", "type": "long" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", - "type": "string" + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "description": "User VM type", - "name": "vmtype", + "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 speed of each vCPU", + "name": "cpuspeed", + "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", + "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", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" } ] @@ -124737,11 +125458,12 @@ "name": "disableAccount", "params": [ { - "description": "If true, only lock the account; else disable the account", + "description": "Account id", "length": 255, - "name": "lock", - "required": true, - "type": "boolean" + "name": "id", + "related": "disableAccount,enableAccount,listAccounts", + "required": false, + "type": "uuid" }, { "description": "Disables specified account.", @@ -124750,14 +125472,6 @@ "required": false, "type": "string" }, - { - "description": "Account id", - "length": 255, - "name": "id", - "related": "disableAccount,enableAccount,listAccounts", - "required": false, - "type": "uuid" - }, { "description": "Disables specified account in this domain.", "length": 255, @@ -124765,48 +125479,137 @@ "related": "listDomains,listDomains", "required": false, "type": "uuid" + }, + { + "description": "If true, only lock the account; else disable the account", + "length": 255, + "name": "lock", + "required": true, + "type": "boolean" } ], "related": "enableAccount,listAccounts", "response": [ { - "description": "the list of acl groups that account belongs to", - "name": "groups", - "type": "list" + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" }, { - "description": "the total number of cpu cores owned by account", - "name": "cputotal", + "description": "the total volume available for this account", + "name": "volumeavailable", + "type": "string" + }, + { + "description": "the total number of public ip addresses allocated for this account", + "name": "iptotal", "type": "long" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "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 the account can own", + "name": "gpulimit", + "type": "string" + }, + { + "description": "name of the Domain the account belongs to", + "name": "domain", + "type": "string" + }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + { + "description": "the state of the account", + "name": "state", + "type": "string" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 name of the account", + "name": "name", "type": "string" }, { - "description": "details for the account", - "name": "accountdetails", - "type": "map" + "description": "the total volume being used by this account", + "name": "volumetotal", + "type": "long" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total number of public ip addresses this account can acquire", + "name": "iplimit", "type": "string" }, { - "description": "the total number of backups available to this account", - "name": "backupavailable", + "description": "the total object storage space (in GiB) owned by the account", + "name": "objectstoragetotal", + "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) available to the account", + "name": "backupstorageavailable", + "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": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", + "type": "string" + }, + { + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", + "type": "string" + }, + { + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", "type": "string" }, { @@ -124814,39 +125617,104 @@ "name": "backupstoragetotal", "type": "long" }, + { + "description": "the list of acl groups that account belongs to", + "name": "groups", + "type": "list" + }, + { + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" + }, + { + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", + "type": "string" + }, { "description": "the total number of backups which can be stored by this account", "name": "backuplimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", + "description": "the total number of networks owned by account", + "name": "networktotal", "type": "long" }, { - "description": "the total number of projects available for administration by this account", - "name": "projectavailable", + "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 total number of network traffic bytes sent", + "name": "sentbytes", + "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) owned by account", - "name": "memorytotal", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", + "type": "string" + }, + { + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", "type": "long" }, { - "description": "the total number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", + "type": "long" + }, + { + "description": "the total secondary storage space (in GiB) available to be used for this account", + "name": "secondarystorageavailable", + "type": "string" + }, + { + "description": "the total number of backups available to this account", + "name": "backupavailable", + "type": "string" + }, + { + "description": "the ID of the role", + "name": "roleid", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", "type": "string" }, { @@ -124854,39 +125722,63 @@ "name": "backuptotal", "type": "long" }, - {}, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", + "description": "the total number of vpcs owned by account", + "name": "vpctotal", + "type": "long" + }, + { + "description": "the id of the account", + "name": "id", "type": "string" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total number of projects the account can own", + "name": "projectlimit", + "type": "string" + }, + { + "description": "the name of the role", + "name": "rolename", + "type": "string" + }, + { + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", + "type": "string" + }, + { + "description": "the total number of buckets which can be stored by this account", + "name": "bucketlimit", + "type": "string" }, { "description": "the list of users associated with account", "name": "user", "response": [ { - "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 account ID of the user", - "name": "accountid", + "description": "the user state", + "name": "state", "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" }, { @@ -124895,24 +125787,19 @@ "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": "the user email address", + "name": "email", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "the date and time the user account was created", @@ -124920,19 +125807,24 @@ "type": "date" }, { - "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", + "type": "boolean" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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" + "description": "the ID of the role", + "name": "roleid", + "type": "string" }, { "description": "true if user has two factor authentication is mandated", @@ -124940,43 +125832,43 @@ "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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 type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the user ID", + "name": "id", "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": "the user state", - "name": "state", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the ID of the role", - "name": "roleid", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { @@ -124984,177 +125876,42 @@ "name": "account", "type": "string" }, - { - "description": "the user ID", - "name": "id", - "type": "string" - }, { "description": "the secret key of the user", "name": "secretkey", "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "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" } ], "type": "list" }, - { - "description": "the id of the account", - "name": "id", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) the account can own", - "name": "secondarystoragelimit", - "type": "string" - }, - { - "description": "the total number of vpcs owned by account", - "name": "vpctotal", - "type": "long" - }, - { - "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 memory (in MB) the account can own", - "name": "memorylimit", - "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) the account can own", - "name": "primarystoragelimit", - "type": "string" - }, - { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", - "type": "string" - }, - { - "description": "the total number of buckets stored by this account", - "name": "buckettotal", - "type": "long" - }, - { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" - }, - { - "description": "the total volume available for this account", - "name": "volumeavailable", - "type": "string" - }, - { - "description": "the total number of networks the account can own", - "name": "networklimit", - "type": "string" - }, - { - "description": "the state of the account", - "name": "state", - "type": "string" - }, - { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total volume being used by this account", - "name": "volumetotal", - "type": "long" - }, - { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", - "type": "long" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) available to the account", - "name": "objectstorageavailable", - "type": "string" - }, { "description": "the total number of network traffic bytes received", "name": "receivedbytes", "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" - }, - { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", - "type": "long" - }, - { - "description": "the name of the account", - "name": "name", - "type": "string" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the default zone of the account", - "name": "defaultzoneid", - "type": "string" - }, - { - "description": "the total number of snapshots which can be stored by this account", - "name": "snapshotlimit", + "description": "the total number of buckets available to this account", + "name": "bucketavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this account", - "name": "memoryavailable", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of snapshots stored by this account", - "name": "snapshottotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) the account can own", - "name": "objectstoragelimit", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { @@ -125163,130 +125920,94 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the total secondary storage space (in GiB) available to be used for this account", - "name": "secondarystorageavailable", - "type": "string" - }, - { - "description": "id of the Domain the account belongs to", - "name": "domainid", - "type": "string" - }, - { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the total object storage space (in GiB) owned by the account", - "name": "objectstoragetotal", + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", "type": "long" }, { - "description": "path of the Domain the account 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 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 total number of cpu cores available to be created for this account", - "name": "cpuavailable", - "type": "string" + "description": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the date when this account was created", - "name": "created", - "type": "date" + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" }, { - "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 number of projects the account can own", - "name": "projectlimit", + "description": "the total object storage space (in GiB) the account can own", + "name": "objectstoragelimit", "type": "string" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "account type (admin, domain-admin, user)", - "name": "accounttype", - "type": "integer" + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", - "type": "string" - }, - { - "description": "name of the Domain the account belongs to", - "name": "domain", + "description": "the total secondary storage space (in GiB) the account can own", + "name": "secondarystoragelimit", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", + "type": "long" }, - {}, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "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 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 total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" } ] }, @@ -125296,12 +126017,11 @@ "name": "listDomains", "params": [ { - "description": "Tag for resource type to return usage", + "description": "flag to display the resource icon for domains", "length": 255, - "name": "tag", + "name": "showicon", "required": false, - "since": "4.20.0", - "type": "string" + "type": "boolean" }, { "description": "List domain by domain ID.", @@ -125311,20 +126031,6 @@ "required": false, "type": "uuid" }, - { - "description": "flag to display the resource icon for domains", - "length": 255, - "name": "showicon", - "required": false, - "type": "boolean" - }, - { - "description": "List domains by domain level.", - "length": 255, - "name": "level", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -125333,18 +126039,18 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "List domain by domain name.", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, { - "description": "List domain by domain name.", + "description": "List domains by domain level.", "length": 255, - "name": "name", + "name": "level", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -125353,6 +126059,13 @@ "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", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "comma separated list of domain details requested, value can be a list of [ all, resource, min]", "length": 255, @@ -125361,58 +126074,51 @@ "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", + "description": "List by keyword", "length": 255, - "name": "listall", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" + }, + { + "description": "Tag for resource type to return usage", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" } ], "related": "listDomains", "response": [ { - "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", + "description": "the total number of vpcs owned by domain", + "name": "vpctotal", "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the domain ID of the parent domain", - "name": "parentdomainid", + "description": "the total number of snapshots available for this domain", + "name": "snapshotavailable", "type": "string" }, { - "description": "the total number of vpcs owned by domain", - "name": "vpctotal", - "type": "long" + "description": "the total object storage space (in GiB) the domain can own", + "name": "objectstoragelimit", + "type": "string" }, { - "description": "the total number of backups stored by this domain", - "name": "backuptotal", - "type": "long" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the total volume being used by this domain", - "name": "volumetotal", + "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 public ip addresses this domain can acquire", - "name": "iplimit", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -125420,35 +126126,31 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the total secondary storage space (in GiB) the domain can own", - "name": "secondarystoragelimit", + "description": "the name of the domain", + "name": "name", "type": "string" }, { - "description": "the total number of networks owned by domain", - "name": "networktotal", - "type": "long" - }, - { - "description": "the total object storage space (in GiB) the domain can own", - "name": "objectstoragelimit", + "description": "the domain ID of the parent domain", + "name": "parentdomainid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the date when this domain was created", + "name": "created", + "type": "date" }, { - "description": "the total number of virtual machines available for this domain to acquire", - "name": "vmavailable", + "description": "the total number of public ip addresses available for this domain to acquire", + "name": "ipavailable", "type": "string" }, { - "description": "the total number of snapshots available for this domain", - "name": "snapshotavailable", - "type": "string" + "description": "the total number of cpu cores owned by domain", + "name": "cputotal", + "type": "long" }, { "description": "the total number of backups which can be stored by this domain", @@ -125456,49 +126158,55 @@ "type": "string" }, { - "description": "the total number of cpu cores the domain can own", - "name": "cpulimit", + "description": "the total number of vpcs available to be created for this domain", + "name": "vpcavailable", "type": "string" }, { - "description": "the total number of networks available to be created for this domain", - "name": "networkavailable", + "description": "the total number of vpcs the domain can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by domain", - "name": "primarystoragetotal", + "description": "the total number of backups stored by this domain", + "name": "backuptotal", "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": "details for the domain", - "name": "domaindetails", - "type": "map" + "description": "the total number of virtual machines that can be deployed by this domain", + "name": "vmlimit", + "type": "string" }, + {}, { - "description": "the total number of networks the domain can own", - "name": "networklimit", - "type": "string" + "description": "the total number of networks owned by domain", + "name": "networktotal", + "type": "long" }, { - "description": "the total number of projects the domain can own", - "name": "projectlimit", + "description": "the total number of gpus owned by domain", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total memory (in MB) available to be created for this domain", + "name": "memoryavailable", "type": "string" }, { - "description": "the level of the domain", - "name": "level", - "type": "integer" + "description": "the total number of public ip addresses this domain can acquire", + "name": "iplimit", + "type": "string" }, { - "description": "the total number of templates which have been created by this domain", - "name": "templatetotal", - "type": "long" + "description": "the total number of buckets which can be stored by this domain", + "name": "bucketlimit", + "type": "string" }, { "description": "the total number of snapshots which can be stored by this domain", @@ -125506,69 +126214,83 @@ "type": "string" }, { - "description": "the total number of projects being administrated by this domain", - "name": "projecttotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by domain", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total number of buckets stored by this domain", - "name": "buckettotal", - "type": "long" + "description": "the total number of buckets available to this domain", + "name": "bucketavailable", + "type": "string" }, { - "description": "the total number of gpus available to be created for this domain", - "name": "gpuavailable", + "description": "whether the domain has one or more sub-domains", + "name": "haschild", + "type": "boolean" + }, + { + "description": "the total backup storage space (in GiB) the domain can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "the total number of vpcs available to be created for this domain", - "name": "vpcavailable", + "description": "the total object storage space (in GiB) available to the domain", + "name": "objectstorageavailable", "type": "string" }, { - "description": "the state of the domain", - "name": "state", + "description": "the total number of cpu cores available to be created for this domain", + "name": "cpuavailable", "type": "string" }, { - "description": "the total object storage space (in GiB) owned by the domain", - "name": "objectstoragetotal", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the total number of snapshots stored by this domain", + "name": "snapshottotal", "type": "long" }, { - "description": "the domain name of the parent domain", - "name": "parentdomainname", - "type": "string" + "description": "the total number of templates which have been created by this domain", + "name": "templatetotal", + "type": "long" }, { - "description": "the name of the domain", - "name": "name", + "description": "the total primary storage space (in GiB) available to be used for this domain", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the total number of backups available to this domain", - "name": "backupavailable", + "description": "the total number of projects the domain can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total backup storage space (in GiB) the domain can own", - "name": "backupstoragelimit", + "description": "the total number of projects available for administration by this domain", + "name": "projectavailable", "type": "string" }, { - "description": "the total secondary storage space (in GiB) owned by domain", - "name": "secondarystoragetotal", - "type": "float" + "description": "the total volume which can be used by this domain", + "name": "volumelimit", + "type": "string" }, - {}, { - "description": "the path of the domain", - "name": "path", + "description": "the state of the domain", + "name": "state", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "the total object storage space (in GiB) owned by the domain", + "name": "objectstoragetotal", + "type": "long" + }, + { + "description": "the total number of backups available to this domain", + "name": "backupavailable", "type": "string" }, { @@ -125577,29 +126299,34 @@ "type": "long" }, { - "description": "the total number of projects available for administration by this domain", - "name": "projectavailable", + "description": "the ID of the domain", + "name": "id", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this domain", - "name": "vmlimit", + "description": "the total volume being used by this domain", + "name": "volumetotal", + "type": "long" + }, + { + "description": "the total primary storage space (in GiB) the domain can own", + "name": "primarystoragelimit", "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 total memory (in MB) the domain can own", - "name": "memorylimit", + "description": "the path of the domain", + "name": "path", "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 backup storage space (in GiB) available to the domain", @@ -125607,24 +126334,24 @@ "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the level of the domain", + "name": "level", + "type": "integer" }, { - "description": "the total number of gpus owned by domain", - "name": "gputotal", - "type": "long" + "description": "the total number of gpus available to be created for this domain", + "name": "gpuavailable", + "type": "string" }, { - "description": "the ID of the domain", - "name": "id", - "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 can be created by this domain", - "name": "templatelimit", - "type": "string" + "description": "The tagged resource limit and count for the domain", + "name": "taggedresources", + "type": "list" }, { "description": "the total volume available for this domain", @@ -125632,29 +126359,18 @@ "type": "string" }, { - "description": "the total number of buckets which can be stored by this domain", - "name": "bucketlimit", - "type": "string" - }, - { - "description": "the total number of buckets available to this domain", - "name": "bucketavailable", - "type": "string" - }, - {}, - { - "description": "the total primary storage space (in GiB) the domain can own", - "name": "primarystoragelimit", + "description": "the total number of templates available to be created by this domain", + "name": "templateavailable", "type": "string" }, { - "description": "the total memory (in MB) available to be created for this domain", - "name": "memoryavailable", + "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 number of templates which can be created by this domain", + "name": "templatelimit", "type": "string" }, { @@ -125663,49 +126379,54 @@ "type": "long" }, { - "description": "the total object storage space (in GiB) available to the domain", - "name": "objectstorageavailable", + "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 volume which can be used by this domain", - "name": "volumelimit", + "description": "the total number of networks available to be created for this domain", + "name": "networkavailable", "type": "string" }, { - "description": "the total number of cpu cores owned by domain", - "name": "cputotal", + "description": "the total primary storage space (in GiB) owned by domain", + "name": "primarystoragetotal", "type": "long" }, { - "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 snapshots stored by this domain", - "name": "snapshottotal", - "type": "long" + "description": "the total number of virtual machines available for this domain to acquire", + "name": "vmavailable", + "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the domain", - "name": "backupstoragetotal", - "type": "long" + "description": "the domain name of the parent domain", + "name": "parentdomainname", + "type": "string" }, { - "description": "the total primary storage space (in GiB) available to be used for this domain", - "name": "primarystorageavailable", + "description": "the total secondary storage space (in GiB) available to be used for this domain", + "name": "secondarystorageavailable", "type": "string" }, { - "description": "the total number of templates available to be created by this domain", - "name": "templateavailable", - "type": "string" + "description": "details for the domain", + "name": "domaindetails", + "type": "map" }, { - "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 allocated for this domain", + "name": "iptotal", + "type": "long" } ] }, @@ -125723,9 +126444,9 @@ "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": "an optional account for the virtual machine. Must be used with domainId.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -125737,21 +126458,6 @@ "required": false, "type": "uuid" }, - { - "description": "The ID of the virtual machine", - "length": 255, - "name": "id", - "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": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "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, @@ -125760,30 +126466,45 @@ "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", + "required": false, + "type": "string" + }, { "description": "used to specify the parameters values for the variables in userdata.", "length": 255, "name": "userdatadetails", "required": false, "type": "map" + }, + { + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" } ], - "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", + "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,createVMFromBackup,importVm", "response": [ { - "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": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "the name of the virtual machine", + "name": "name", + "type": "string" }, { - "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 group ID of the virtual machine", @@ -125791,8 +126512,8 @@ "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -125800,165 +126521,352 @@ "name": "userid", "type": "string" }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "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 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 date when this virtual machine was created", "name": "created", "type": "date" }, { - "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": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the name of the availability zone for the virtual machine", + "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 number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" }, { - "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 ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", "type": "date" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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", + "type": "string" + }, + { + "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", + "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the name of the host for the virtual machine", + "name": "hostname", + "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", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", + "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "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", + "description": "the user's name who deployed the virtual machine", + "name": "username", "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 userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the project name of the vm", + "name": "project", + "type": "string" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" + }, + { + "description": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "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" + } + ], + "type": "set" + }, + { + "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 incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "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 name of the gpu card to which service offering is linked", + "name": "gpucardname", + "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": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "MTU configured on the NIC", + "name": "mtu", + "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 ip address of the nic", @@ -125971,43 +126879,53 @@ "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the IPv6 address of network", + "name": "ip6address", "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": "Type of adapter if available", - "name": "adaptertype", + "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": "the ID of the nic", - "name": "id", + "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 broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { @@ -126016,55 +126934,75 @@ "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": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "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" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "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": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, + { + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, { "description": "IP addresses associated with NIC found for unmanaged VM", "name": "ipaddresses", @@ -126074,19 +127012,24 @@ "type": "set" }, { - "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 memory allocated for the virtual machine", - "name": "memory", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "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 name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { "description": "the ID of the virtual machine", @@ -126094,62 +127037,61 @@ "type": "string" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, - {}, { - "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", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" - }, + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", + "response": [ { - "description": "the description of the security group", - "name": "description", + "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 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 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" }, { @@ -126158,76 +127100,14 @@ "type": "integer" }, { - "description": "security group name", - "name": "securitygroupname", - "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 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": "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" - }, - { - "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": "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": "security group name", + "name": "securitygroupname", + "type": "string" }, { "description": "account owning the security group rule", @@ -126235,54 +127115,32 @@ "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 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 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 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 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 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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -126291,8 +127149,8 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -126301,8 +127159,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" }, { @@ -126311,28 +127169,23 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "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": "customer associated with the tag", + "name": "customer", "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", @@ -126342,31 +127195,6 @@ "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", - "type": "string" } ], "type": "set" @@ -126375,29 +127203,24 @@ "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", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -126411,18 +127234,23 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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": "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", "type": "string" }, { @@ -126434,18 +127262,8 @@ "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", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { @@ -126454,94 +127272,156 @@ "type": "set" }, { - "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 project id of the group", - "name": "projectid", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" - }, - { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" - }, - { - "description": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", - "response": [ - { - "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 ID of the affinity group", - "name": "id", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the affinity group", + "description": "the name of the security 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", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the domain name of the affinity group", - "name": "domain", + "description": "the description of the security group", + "name": "description", "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 the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "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": "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 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 starting IP of the security group rule", + "name": "startport", + "type": "integer" + }, + { + "description": "the list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "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": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + } + ], + "type": "set" + }, + { + "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 project ID of the affinity group", + "description": "the project id of the group", "name": "projectid", "type": "string" } @@ -126549,108 +127429,49 @@ "type": "set" }, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the virtual machine", - "name": "name", - "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 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 userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "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": "publicip", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "the ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "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 state of the virtual machine", - "name": "state", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, + {}, { - "description": "the project name of the vm", - "name": "project", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { @@ -126659,80 +127480,75 @@ "type": "long" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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": "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": "resource type", - "name": "resourcetype", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "tag key name", - "name": "key", - "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", "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": "the domain associated with the tag", - "name": "domain", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "customer associated with the tag", - "name": "customer", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" } ], "type": "set" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { @@ -126741,44 +127557,28 @@ "type": "map" }, { - "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", - "name": "rootdevicetype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "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": "OS type id of the vm", - "name": "ostypeid", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { @@ -126786,145 +127586,66 @@ "name": "hostcontrolstate", "type": "string" }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" - }, - { - "description": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, { "description": " an alternate display text of the template for the virtual machine", "name": "templatedisplaytext", "type": "string" }, + {}, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "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", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "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": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "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": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", - "type": "string" + "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": "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" @@ -126935,12 +127656,12 @@ "name": "deleteTemplate", "params": [ { - "description": "the ID of the template", + "description": "Force delete a template.", "length": 255, - "name": "id", - "related": "listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" + "name": "forced", + "required": false, + "since": "4.9+", + "type": "boolean" }, { "description": "the ID of zone of the template", @@ -126959,26 +127680,15 @@ "type": "boolean" }, { - "description": "Force delete a template.", + "description": "the ID of the template", "length": 255, - "name": "forced", - "required": false, - "since": "4.9+", - "type": "boolean" + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,createTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", + "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", @@ -126989,6 +127699,17 @@ "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" } ] }, @@ -126998,19 +127719,19 @@ "name": "listNetworkACLLists", "params": [ { - "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 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": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", @@ -127020,32 +127741,40 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list network ACLs by VPC ID", "length": 255, - "name": "fordisplay", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "list network ACLs by specified name", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "description": "Lists network ACL with the specified ID.", "length": 255, - "name": "page", + "name": "id", + "related": "createNetworkACLList,listNetworkACLLists", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, @@ -127058,25 +127787,24 @@ "type": "uuid" }, { - "description": "list network ACLs by VPC ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomains", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "list network ACLs by specified name", "length": 255, - "name": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -127086,54 +127814,47 @@ "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" } ], "related": "createNetworkACLList", "response": [ { - "description": "Id of the VPC this ACL is associated with", - "name": "vpcid", - "type": "string" + "description": "is ACL for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the ID of the ACL", - "name": "id", + "description": "Description of the ACL", + "name": "description", "type": "string" }, + {}, { - "description": "Description of the ACL", - "name": "description", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { - "description": "Name of the VPC this ACL is associated with", - "name": "vpcname", + "description": "Id of the VPC this ACL is associated with", + "name": "vpcid", "type": "string" }, { - "description": "is ACL for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the ID of the ACL", + "name": "id", + "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the Name of the ACL", - "name": "name", + "description": "Name of the VPC this ACL is associated with", + "name": "vpcname", "type": "string" }, - {}, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -127158,24 +127879,14 @@ "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", + "description": "state of the disk volume", + "name": "volumestate", "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", + "type": "string" }, { "description": "the type of the snapshot", @@ -127183,28 +127894,18 @@ "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": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", + "type": "boolean" }, { - "description": "id of the availability zone", - "name": "zoneid", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { @@ -127212,23 +127913,23 @@ "name": "tags", "response": [ { - "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 account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -127237,68 +127938,94 @@ "type": "string" }, { - "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": "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": "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": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the status of the template", - "name": "status", + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "state of the snapshot on the datastore", + "name": "datastorestate", + "type": "string" + }, + { + "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": "the project id of the snapshot", + "name": "projectid", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "name of the snapshot", + "name": "name", "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", + "type": "string" }, + {}, + {}, { - "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": "name of the disk volume", - "name": "volumename", + "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" + "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": "type of the disk volume", @@ -127306,30 +128033,24 @@ "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", - "type": "string" - }, - { - "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", + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", "type": "long" }, - {}, { - "description": "name of the snapshot", - "name": "name", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", - "type": "string" + "description": "virtual size of backedup snapshot on image store", + "name": "virtualsize", + "type": "long" }, { "description": "path of the Domain the snapshot's account belongs to", @@ -127337,58 +128058,58 @@ "type": "string" }, { - "description": "id of the os on volume", - "name": "ostypeid", + "description": "name of the disk volume", + "name": "volumename", "type": "string" }, { - "description": "type of the datastore for the snapshot entry", - "name": "datastoretype", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "ID of the disk volume", - "name": "volumeid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", - "type": "string" + "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": "the account associated with the snapshot", + "name": "account", + "type": "string" }, { - "description": "the project id of the snapshot", - "name": "projectid", + "description": "ID of the disk volume", + "name": "volumeid", "type": "string" }, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "id of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the domain ID of the snapshot's account", - "name": "domainid", + "description": "type of the datastore for the snapshot entry", + "name": "datastoretype", "type": "string" }, { - "description": " the date the snapshot was created", - "name": "created", - "type": "date" + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" }, { - "description": "state of the snapshot on the datastore", - "name": "datastorestate", + "description": "the status of the template", + "name": "status", "type": "string" } ] @@ -127399,12 +128120,12 @@ "name": "updateVpnGateway", "params": [ { - "description": "id of customer gateway", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "id", - "related": "updateVpnGateway", - "required": true, - "type": "uuid" + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" }, { "description": "an optional field, whether to the display the vpn to the end user or not", @@ -127415,47 +128136,30 @@ "type": "boolean" }, { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "id of customer gateway", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", - "type": "string" + "name": "id", + "related": "updateVpnGateway", + "required": true, + "type": "uuid" } ], "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", - "type": "string" - }, { "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 domain path of the owner", + "name": "domainpath", + "type": "string" }, { "description": "the public IP address", @@ -127463,28 +128167,35 @@ "type": "string" }, { - "description": "the domain id of the owner", - "name": "domainid", + "description": "the vpc name of this gateway", + "name": "vpcname", "type": "string" }, + {}, { - "description": "the domain path of the owner", - "name": "domainpath", + "description": "the project id", + "name": "projectid", "type": "string" }, + {}, { - "description": "the project name", - "name": "project", + "description": "the domain id of the owner", + "name": "domainid", "type": "string" }, { - "description": "the project id", - "name": "projectid", + "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": "is vpn gateway for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the vpn gateway ID", + "name": "id", "type": "string" }, { @@ -127493,8 +128204,18 @@ "type": "string" }, { - "description": "the domain name of the owner", - "name": "domain", + "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 name", + "name": "project", "type": "string" } ], @@ -127516,27 +128237,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 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" - } + {}, + {} ] }, { @@ -127545,12 +128266,18 @@ "name": "deleteSecurityGroup", "params": [ { - "description": "the project of the security group", + "description": "the account of the security group. Must be specified with domain ID", "length": 255, - "name": "projectid", - "related": "", + "name": "account", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "The ID of the security group. Mutually exclusive with id parameter", + "length": 255, + "name": "name", + "required": false, + "type": "string" }, { "description": "the domain ID of account owning the security group", @@ -127561,11 +128288,12 @@ "type": "uuid" }, { - "description": "the account of the security group. Must be specified with domain ID", + "description": "the project of the security group", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "The ID of the security group. Mutually exclusive with name parameter", @@ -127574,37 +128302,30 @@ "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": "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" }, { "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" } ] }, @@ -127614,31 +128335,24 @@ "name": "createGuiTheme", "params": [ { - "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", + "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": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", "length": 65535, - "name": "css", + "name": "jsonconfiguration", "required": false, "type": "string" }, { - "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, + "description": "A name to identify the theme.", + "length": 2048, + "name": "name", + "required": true, "type": "string" }, { @@ -127649,9 +128363,9 @@ "type": "string" }, { - "description": "The JSON with the configurations to be retrieved and imported into the GUI when matching the theme access configurations.", + "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": "jsonconfiguration", + "name": "domainids", "required": false, "type": "string" }, @@ -127663,45 +128377,37 @@ "type": "boolean" }, { - "description": "A description for the theme.", - "length": 4096, - "name": "description", + "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": "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 name to identify the theme.", - "length": 2048, - "name": "name", - "required": true, + "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" } ], "related": "", "response": [ { - "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": "Name of the GUI theme.", - "name": "name", + "description": "ID of the custom GUI theme.", + "name": "id", "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", + "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" }, { @@ -127716,28 +128422,44 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 CSS to be retrieved and imported into the GUI when matching the theme access configurations.", - "name": "css", - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + { + "description": "When the GUI theme was removed.", + "name": "removed", + "type": "date" + }, { "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", + "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": "Name of the GUI theme.", + "name": "name", + "type": "string" + }, + { + "description": "The CSS to be retrieved and imported into the GUI when matching the theme access configurations.", + "name": "css", "type": "string" }, { @@ -127746,11 +128468,10 @@ "type": "date" }, { - "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" + } ], "since": "4.21.0.0" }, @@ -127759,13 +128480,6 @@ "isasync": true, "name": "importVolume", "params": [ - { - "description": "the path of the volume", - "length": 255, - "name": "path", - "required": true, - "type": "string" - }, { "description": "import volume for the project", "length": 255, @@ -127775,33 +128489,32 @@ "type": "uuid" }, { - "description": "the ID of the disk offering linked to the volume", + "description": "the name of the volume. If not set, it will be set to the path of the volume.", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the name of the volume. If not set, it will be set to the path of the volume.", + "description": "import volume to the domain specified", "length": 255, - "name": "name", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the storage pool", + "description": "the path of the volume", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "path", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "import volume to the domain specified", + "description": "the ID of the disk offering linked to the volume", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, @@ -127811,43 +128524,51 @@ "name": "account", "required": false, "type": "string" + }, + { + "description": "the ID of the storage pool", + "length": 255, + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "required": true, + "type": "uuid" } ], "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": "max iops of the disk volume", - "name": "maxiops", - "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": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", + "description": "the bytes actually consumed on disk", + "name": "physicalsize", "type": "long" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "ID of the disk offering", + "name": "diskofferingid", "type": "string" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "pod name of the volume", + "name": "podname", + "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "name of the disk offering", + "name": "diskofferingname", "type": "string" }, { @@ -127856,18 +128577,28 @@ "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" + }, + { + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { @@ -127876,24 +128607,19 @@ "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" - }, - { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "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": "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", @@ -127901,28 +128627,73 @@ "type": "long" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", + "description": "cluster name where the volume is allocated", + "name": "clustername", + "type": "string" + }, + { + "description": "the domain associated with the disk volume", + "name": "domain", + "type": "string" + }, + { + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", "type": "long" }, { - "description": "the status of the volume", - "name": "status", + "description": "the project name of the vpn", + "name": "project", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, + { + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" + }, + { + "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": "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 optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", + "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": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the path of the volume", + "name": "path", "type": "string" }, { @@ -127931,101 +128702,112 @@ "type": "date" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "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 format of the disk encryption if applicable", + "name": "encryptformat", + "type": "string" }, + {}, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "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": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "the read (IO) of disk on the vm", + "name": "diskioread", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "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", + "name": "hasannotations", + "type": "boolean" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "display name of the virtual machine", + "name": "vmdisplayname", "type": "string" }, { - "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", + "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "an optional field whether to the display the volume to the end user or not.", + "name": "displayvolume", + "type": "boolean" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, + { + "description": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", @@ -128036,8 +128818,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -128051,13 +128833,13 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -128066,48 +128848,32 @@ "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": "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" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, - {}, - { - "description": "state of the virtual machine", - "name": "vmstate", - "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 for the virtual machine. A -1 is returned if the virtual machine was created from an ISO file.", - "name": "templateid", - "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": "the ID of the ISO attached to the virtual machine", @@ -128115,99 +128881,64 @@ "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, - { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" - }, { "description": "the boolean state of whether the volume is destroyed or not", "name": "destroyed", "type": "boolean" }, { - "description": "cluster name where the volume is allocated", - "name": "clustername", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" - }, - { - "description": "ID of the disk volume", - "name": "id", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "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", + "description": "the chain info of the volume", + "name": "chaininfo", "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": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", - "type": "long" - }, - { - "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 volume has delete protection.", @@ -128215,29 +128946,19 @@ "type": "boolean" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "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 display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" - }, - { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" } ], "since": "4.19.1" @@ -128256,28 +128977,26 @@ "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 the template requires HVM, false otherwise", "length": 255, - "name": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "requireshvm", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "details", "required": false, - "since": "4.19.0", - "type": "uuid" + "type": "map" }, { - "description": "32 or 64 bit", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "bits", + "name": "account", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "string" }, { "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", @@ -128294,33 +129013,39 @@ "type": "string" }, { - "description": "true if this template is a public template, false otherwise", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "ispublic", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "create template for the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "the zone for the template. Can be specified with snapshot only", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "passwordenabled", + "required": false, + "type": "boolean" + }, + { + "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": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, - "since": "4.19.0", "type": "uuid" }, { - "description": "true if the template requires HVM, false otherwise", + "description": "true if this template is a public template, false otherwise", "length": 255, - "name": "requireshvm", + "name": "ispublic", "required": false, "type": "boolean" }, @@ -128328,16 +129053,25 @@ "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": "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", + "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,createVMFromBackup,importVm", "required": false, "type": "uuid" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "passwordenabled", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "since": "4.19.0", + "type": "uuid" + }, + { + "description": "The display text of the template, defaults to the 'name'.", + "length": 4096, + "name": "displaytext", + "required": false, + "type": "string" }, { "description": "the name of the template", @@ -128347,25 +129081,26 @@ "type": "string" }, { - "description": "the tag for this template.", + "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": "templatetag", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the tag for this template.", "length": 255, - "name": "isfeatured", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "32 or 64 bit", "length": 255, - "name": "details", + "name": "bits", "required": false, - "type": "map" + "type": "integer" }, { "description": "the ID of the OS Type that best represents the OS of this template.", @@ -128376,123 +129111,43 @@ "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", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "isfeatured", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "create template for the project", + "description": "the zone for the template. Can be specified with snapshot only", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, + "since": "4.19.0", "type": "uuid" - }, - { - "description": "The display text of the template, defaults to the 'name'.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" } ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "response": [ - {}, - { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" - }, - { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", - "type": "boolean" - }, - { - "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": "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" - }, - { - "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": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" - }, { "description": "true if the entity/resource has annotations", "name": "hasannotations", "type": "boolean" }, - { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "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": "the size of the template", - "name": "size", - "type": "long" - }, - { - "description": "the type of the template", - "name": "templatetype", - "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": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "true if the ISO is bootable, false otherwise", @@ -128500,43 +129155,38 @@ "type": "boolean" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", - "type": "string" - }, - { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "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 this template is a featured template, false otherwise", - "name": "isfeatured", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" + "description": "the template ID", + "name": "id", + "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { @@ -128545,51 +129195,44 @@ "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": "the project id of the template", + "name": "projectid", + "type": "string" }, - {}, - {}, { - "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": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "The name of extension linked to this template", + "name": "extensionname", + "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", - "type": "string" + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "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", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { "description": "the name of the OS type for this template.", @@ -128597,28 +129240,23 @@ "type": "string" }, { - "description": "CPU Arch of the template", - "name": "arch", - "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 the template is managed across all Zones, false otherwise", + "name": "crossZones", "type": "boolean" }, { - "description": "the template name", - "name": "name", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { @@ -128626,54 +129264,75 @@ "name": "zoneid", "type": "string" }, + { + "description": "the type of the template", + "name": "templatetype", + "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 true it indicates that the template can be used for CKS cluster deployments", "name": "forcks", "type": "boolean" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the template ID", - "name": "id", + "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": "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 userdata linked to this template", - "name": "userdataname", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -128685,29 +129344,19 @@ "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", + "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" }, { @@ -128716,13 +129365,13 @@ "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 id the tag belongs to", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -128730,38 +129379,110 @@ "name": "key", "type": "string" }, + { + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, { "description": "id of the resource", "name": "resourceid", "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" } ], "type": "set" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", + "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 date this template was created", - "name": "created", - "type": "date" + "description": "the size of the template", + "name": "size", + "type": "long" }, { - "description": "the project name of the template", - "name": "project", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "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 project name of the template", + "name": "project", + "type": "string" + }, { "description": "Lists the download progress of a template across all secondary storages", "name": "downloaddetails", "type": "list" + }, + { + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + {}, + { + "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 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": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" } ] }, @@ -128780,11 +129501,16 @@ } ], "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", @@ -128793,14 +129519,9 @@ }, {}, { - "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.14.0" @@ -128811,11 +129532,11 @@ "name": "uploadCustomCertificate", "params": [ { - "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", - "length": 255, - "name": "id", + "description": "The private key for the attached certificate.", + "length": 65535, + "name": "privatekey", "required": false, - "type": "integer" + "type": "string" }, { "description": "The certificate to be uploaded.", @@ -128825,18 +129546,11 @@ "type": "string" }, { - "description": "DNS domain suffix that the certificate is granted for.", + "description": "An integer providing the location in a chain that the certificate will hold. Usually, this can be left empty. When creating a chain, the top level certificate should have an ID of 1, with each step in the chain incrementing by one. Example, CA with id = 1, Intermediate CA with id = 2, Site certificate with ID = 3", "length": 255, - "name": "domainsuffix", - "required": true, - "type": "string" - }, - { - "description": "The private key for the attached certificate.", - "length": 65535, - "name": "privatekey", + "name": "id", "required": false, - "type": "string" + "type": "integer" }, { "description": "A name / alias for the certificate.", @@ -128844,19 +129558,26 @@ "name": "name", "required": false, "type": "string" + }, + { + "description": "DNS domain suffix that the certificate is granted for.", + "length": 255, + "name": "domainsuffix", + "required": true, + "type": "string" } ], "related": "", "response": [ {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "message of the certificate upload operation", + "name": "message", "type": "string" }, { - "description": "message of the certificate upload operation", - "name": "message", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, @@ -128872,6 +129593,13 @@ "isasync": false, "name": "listDedicatedClusters", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "the ID of the domain associated with the cluster", "length": 255, @@ -128880,6 +129608,14 @@ "required": false, "type": "uuid" }, + { + "description": "the ID of the cluster", + "length": 255, + "name": "clusterid", + "related": "addCluster,updateCluster", + "required": false, + "type": "uuid" + }, { "description": "the name of the account associated with the cluster. Must be used with domainId.", "length": 255, @@ -128888,11 +129624,12 @@ "type": "string" }, { - "description": "", + "description": "list dedicated clusters by affinity group", "length": 255, - "name": "pagesize", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List by keyword", @@ -128901,41 +129638,19 @@ "required": false, "type": "string" }, - { - "description": "the ID of the cluster", - "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", - "required": false, - "type": "uuid" - }, { "description": "", "length": 255, "name": "page", "required": false, "type": "integer" - }, - { - "description": "list dedicated clusters by affinity group", - "length": 255, - "name": "affinitygroupid", - "related": "", - "required": false, - "type": "uuid" } ], "related": "", "response": [ - {}, - { - "description": "the ID of the dedicated resource", - "name": "id", - "type": "string" - }, { - "description": "the domain ID of the cluster", - "name": "domainid", + "description": "the ID of the cluster", + "name": "clusterid", "type": "string" }, { @@ -128944,31 +129659,37 @@ "type": "string" }, { - "description": "the Account ID of the cluster", - "name": "accountid", - "type": "string" - }, - { - "description": "the ID of the cluster", - "name": "clusterid", + "description": "the name of the cluster", + "name": "clustername", "type": "string" }, { - "description": "the name of the cluster", - "name": "clustername", + "description": "the Account ID of the cluster", + "name": "accountid", "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 cluster", + "name": "domainid", + "type": "string" + }, { "description": "the Dedication Affinity Group ID of the cluster", "name": "affinitygroupid", "type": "string" - } + }, + { + "description": "the ID of the dedicated resource", + "name": "id", + "type": "string" + }, + {} ] }, { @@ -128978,22 +129699,22 @@ "params": [], "related": "", "response": [ - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "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", "type": "integer" + }, + { + "description": "timestamp when the run got over", + "name": "updated_on", + "type": "date" } ], "since": "4.7.0" @@ -129004,11 +129725,11 @@ "name": "listTungstenFabricNetwork", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -129033,11 +129754,11 @@ "type": "string" }, { - "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 include public network. Default value is false", @@ -129049,36 +129770,36 @@ ], "related": "", "response": [ + { + "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": "Tungsten-Fabric network uuid", - "name": "uuid", + "description": "Tungsten-Fabric network 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 network name", - "name": "name", + "description": "Tungsten-Fabric network 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" } ] @@ -129096,11 +129817,11 @@ "type": "integer" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "zone Id", @@ -129111,15 +129832,21 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "addTrafficMonitor", "response": [ + {}, + { + "description": "the management IP address of the external firewall", + "name": "ipaddress", + "type": "string" + }, { "description": "the number of times to retry requests to the external firewall", "name": "numretries", @@ -129131,14 +129858,13 @@ "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "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 timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { @@ -129151,12 +129877,7 @@ "name": "zoneid", "type": "string" }, - {}, - { - "description": "the management IP address of the external firewall", - "name": "ipaddress", - "type": "string" - } + {} ] }, { @@ -129175,44 +129896,44 @@ ], "related": "", "response": [ + { + "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": "the account of the bgp peer", - "name": "account", - "type": "string" + "description": "AS number of bgp peer", + "name": "asnumber", + "type": "long" }, { - "description": "IPv4 address of bgp peer", - "name": "ipaddress", + "description": "id of zone to which the bgp peer belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "IPv6 address of bgp peer", - "name": "ip6address", + "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 domain name of the bgp peer", - "name": "domain", + "description": "the project id of the bgp peer", + "name": "projectid", "type": "string" }, { - "description": "password of bgp peer", - "name": "password", - "type": "string" + "description": "additional key/value details of the bgp peer", + "name": "details", + "type": "map" }, { - "description": "id of zone to which the bgp peer belongs to.", - "name": "zoneid", + "description": "IPv4 address of bgp peer", + "name": "ipaddress", "type": "string" }, { @@ -129221,40 +129942,40 @@ "type": "string" }, { - "description": "the domain ID of the bgp peer", - "name": "domainid", + "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": "IPv6 address of bgp peer", + "name": "ip6address", + "type": "string" }, { - "description": "the project name of the bgp peer", - "name": "project", + "description": "password of bgp peer", + "name": "password", "type": "string" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "date when this bgp peer was created.", + "name": "created", + "type": "date" }, { - "description": "id of the bgp peer", - "name": "id", + "description": "the account of the bgp peer", + "name": "account", "type": "string" }, + {}, { - "description": "AS number of bgp peer", - "name": "asnumber", - "type": "long" + "description": "the domain name of the bgp peer", + "name": "domain", + "type": "string" }, { - "description": "the project id of the bgp peer", - "name": "projectid", + "description": "the project name of the bgp peer", + "name": "project", "type": "string" } ], @@ -129266,19 +129987,21 @@ "name": "updatePortForwardingRule", "params": [ { - "description": "the ID of the virtual machine for the port forwarding rule", + "description": "the ID of 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, + "name": "id", + "related": "updatePortForwardingRule", + "required": true, + "since": "4.4", "type": "uuid" }, { - "description": "the private end port of the port forwarding rule", + "description": "the ID of the virtual machine for the port forwarding rule", "length": 255, - "name": "privateendport", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -129289,19 +130012,12 @@ "type": "boolean" }, { - "description": "the private start port of the port forwarding rule", + "description": "the private end port of the port forwarding rule", "length": 255, - "name": "privateport", + "name": "privateendport", "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, @@ -129311,13 +130027,11 @@ "type": "string" }, { - "description": "the ID of 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": "id", - "related": "updatePortForwardingRule", - "required": true, - "since": "4.4", - "type": "uuid" + "name": "cidrlist", + "required": false, + "type": "list" }, { "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", @@ -129326,48 +130040,20 @@ "required": false, "since": "4.4", "type": "string" - } - ], - "related": "", - "response": [ - { - "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", - "type": "string" }, { - "description": "the starting port of port forwarding rule's private port range", + "description": "the private start port of the port forwarding rule", + "length": 255, "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" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "required": false, "type": "integer" - }, + } + ], + "related": "", + "response": [ { - "description": "the ending port of port forwarding rule's private port range", - "name": "publicendport", + "description": "the public ip address for the port forwarding rule", + "name": "ipaddress", "type": "string" }, { @@ -129376,18 +130062,8 @@ "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", + "description": "the starting port of port forwarding rule's private port range", + "name": "privateport", "type": "string" }, { @@ -129400,13 +130076,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -129415,13 +130091,8 @@ "type": "string" }, { - "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" }, { @@ -129430,13 +130101,8 @@ "type": "string" }, { - "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" }, { @@ -129450,22 +130116,51 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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" } ], "type": "list" }, - {}, { - "description": "the ID of the port forwarding rule", - "name": "id", + "description": "the starting port of port forwarding rule's public port range", + "name": "publicport", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "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", + "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 ending port of port forwarding rule's private port range", + "name": "privateendport", "type": "string" }, { @@ -129474,16 +130169,42 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the vm ip address for the port forwarding rule", + "name": "vmguestip", "type": "string" }, { - "description": "the public ip address for the port forwarding rule", - "name": "ipaddress", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -129492,26 +130213,25 @@ "name": "associateIpAddress", "params": [ { - "description": "the VPC you want the IP address to be associated with", + "description": "the account to associate with this IP address", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "account", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the IP to the end user or not", + "description": "the VPC you want the IP address to be associated with", "length": 255, - "name": "fordisplay", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "The network this IP address should be associated to.", + "description": "Deploy VM for the project", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -129531,40 +130251,41 @@ "type": "integer" }, { - "description": "Deploy VM for the project", + "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": "projectid", - "related": "", + "name": "isportable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the account to associate with this IP address", + "description": "the ID of the domain to associate with this IP address", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the domain to associate with this IP address", + "description": "the ID of the availability zone you want to acquire an public IP address from", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "zoneid", + "related": "listZones", "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", + "description": "an optional field, whether to the display the IP to the end user or not", "length": 255, - "name": "isportable", + "name": "fordisplay", "required": false, + "since": "4.4", "type": "boolean" }, { - "description": "the ID of the availability zone you want to acquire an public IP address from", + "description": "The network this IP address should be associated to.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" } @@ -129572,8 +130293,8 @@ "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", + "description": "the project name of the address", + "name": "project", "type": "string" }, { @@ -129582,175 +130303,169 @@ "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" }, { - "description": "the domain the public IP address is associated with", - "name": "domain", - "type": "string" + "description": "true if this ip is for static nat, false otherwise", + "name": "isstaticnat", + "type": "boolean" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", - "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 project name of the address", - "name": "project", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "public IP address id", - "name": "id", + "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": "is public IP portable across the zones", - "name": "isportable", - "type": "boolean" + "description": "the physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" + "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", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the ID of the zone the public IP address belongs to", + "name": "zoneid", + "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", "type": "string" }, { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "type": "string" }, - {}, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", - "name": "state", - "type": "string" + "description": "true if range is dedicated for external network providers", + "name": "forprovider", + "type": "boolean" }, - {}, { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "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": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", - "type": "boolean" + "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", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "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", + "description": "the name of the Network where ip belongs to", + "name": "networkname", "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", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "public IP address id", + "name": "id", "type": "string" }, { - "description": "true if this ip is for static nat, false otherwise", - "name": "isstaticnat", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "date the public IP address was acquired", + "name": "allocated", + "type": "date" }, { - "description": "virtual machine id the ip address is assigned to", - "name": "virtualmachineid", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is public ip 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": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", "type": "string" }, { - "description": "VPC id the ip belongs to", - "name": "vpcid", + "description": "virtual machine id the ip address is assigned to", + "name": "virtualmachineid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", "type": "string" }, { - "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 ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", + "name": "vlanid", "type": "string" }, { @@ -129758,13 +130473,13 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -129773,61 +130488,67 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "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": "customer associated with the tag", + "name": "customer", "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": "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" } ], "type": "list" }, { - "description": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "public IP address", + "name": "ipaddress", "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", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, + {}, + { + "description": "is public IP portable across the zones", + "name": "isportable", + "type": "boolean" + }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" } ] @@ -129838,16 +130559,16 @@ "name": "getSolidFireVolumeAccessGroupIds", "params": [ { - "description": "Cluster UUID", + "description": "Storage Pool UUID", "length": 255, - "name": "clusterid", + "name": "storageid", "required": true, "type": "string" }, { - "description": "Storage Pool UUID", + "description": "Cluster UUID", "length": 255, - "name": "storageid", + "name": "clusterid", "required": true, "type": "string" } @@ -129857,9 +130578,9 @@ {}, {}, { - "description": "SolidFire Volume Access Group Ids", - "name": "solidFireVolumeAccessGroupIds", - "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", @@ -129867,9 +130588,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "SolidFire Volume Access Group Ids", + "name": "solidFireVolumeAccessGroupIds", + "type": "long[]" } ] }, @@ -129889,10 +130610,16 @@ ], "response": [ { - "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", @@ -129900,16 +130627,10 @@ }, {}, { - "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" - }, - {} + } ] }, { @@ -129919,21 +130640,16 @@ "params": [], "related": "listAlerts", "response": [ + { + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "description of the alert", "name": "description", @@ -129941,8 +130657,8 @@ }, {}, { - "description": "the name of the alert", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -129952,9 +130668,14 @@ }, {}, { - "description": "the id of the alert", - "name": "id", + "description": "the name of the alert", + "name": "name", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -129963,27 +130684,6 @@ "isasync": true, "name": "createNetworkACL", "params": [ - { - "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": "error code for this ICMP message", - "length": 255, - "name": "icmpcode", - "required": false, - "type": "integer" - }, - { - "description": "type of the ICMP message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, { "description": "The network of the VM the ACL will be created for", "length": 255, @@ -129993,31 +130693,30 @@ "type": "uuid" }, { - "description": "The network of the VM the ACL will be created for", + "description": "The number of the ACL item, its ordering", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "number", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "A description indicating why the ACL rule is required.", + "description": "the CIDR list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "reason", + "name": "cidrlist", "required": false, - "type": "string" + "type": "list" }, { - "description": "The number of the ACL item, its ordering", + "description": "error code for this ICMP message", "length": 255, - "name": "number", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the starting port of ACL", + "description": "the ending port of ACL", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" }, @@ -130036,13 +130735,6 @@ "required": false, "type": "string" }, - { - "description": "the ending port of ACL", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, { "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, @@ -130051,79 +130743,76 @@ "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "The network of the VM the ACL will be created for", "length": 255, - "name": "action", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "type": "string" - } - ], - "related": "updateNetworkACLItem,moveNetworkAclItem", - "response": [ - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "type": "uuid" }, { - "description": "the protocol of the ACL", - "name": "protocol", + "description": "A description indicating why the ACL rule is required.", + "length": 255, + "name": "reason", + "required": false, "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "scl entry action, allow or deny", + "length": 255, + "name": "action", + "required": false, "type": "string" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" + "description": "type of the ICMP message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" }, + { + "description": "the starting port of ACL", + "length": 255, + "name": "startport", + "required": false, + "type": "integer" + } + ], + "related": "updateNetworkACLItem,moveNetworkAclItem", + "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": "error code for this icmp message", - "name": "icmpcode", - "type": "integer" - }, - { - "description": "the state of the rule", - "name": "state", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { - "description": "Number of the ACL Item", - "name": "number", + "description": "type of the icmp message being sent", + "name": "icmptype", "type": "integer" }, { - "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 list of resource tags associated with the network ACLs", "name": "tags", "response": [ { - "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" }, { @@ -130132,61 +130821,92 @@ "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 id the tag belongs to", - "name": "projectid", + "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 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 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": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "list" }, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", + "description": "the ID of the ACL Item", + "name": "id", + "type": "string" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the starting port of ACL's port range", - "name": "startport", + "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": "the name of the ACL this item belongs to", + "name": "aclname", + "type": "string" + }, + { + "description": "the state of the rule", + "name": "state", + "type": "string" + }, + {}, + { + "description": "the protocol of the ACL", + "name": "protocol", "type": "string" }, { @@ -130195,13 +130915,14 @@ "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 ID of the ACL Item", - "name": "id", + "description": "the starting port of ACL's port range", + "name": "startport", "type": "string" }, { @@ -130216,6 +130937,14 @@ "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": "an optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", "length": 255, @@ -130231,19 +130960,11 @@ "required": false, "type": "string" }, - { - "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": "The ID of the virtual machine", "length": 255, "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", + "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,createVMFromBackup,importVm", "required": true, "type": "uuid" }, @@ -130263,62 +130984,42 @@ "type": "uuid" } ], - "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", + "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,createVMFromBackup,importVm", "response": [ + {}, { - "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": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - {}, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", + "description": "the date when this virtual machine was created", + "name": "created", "type": "date" }, { - "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", - "type": "string" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", + "type": "boolean" }, { - "description": "the project name of the vm", - "name": "project", + "description": "the group ID of the virtual machine", + "name": "groupid", "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" }, { @@ -130326,33 +131027,28 @@ "name": "readonlydetails", "type": "string" }, + { + "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 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", + "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 name of the affinity group", - "name": "name", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { @@ -130366,8 +131062,8 @@ "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { @@ -130375,6 +131071,16 @@ "name": "domainid", "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 name of the affinity group", "name": "domain", @@ -130386,27 +131092,27 @@ "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" } ], "type": "set" }, { - "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 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", + "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { "description": "Os type ID of the virtual machine", @@ -130414,53 +131120,58 @@ "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "the date when this virtual machine was updated last time", - "name": "lastupdated", - "type": "date" + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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": "the VM's primary IP address", - "name": "ipaddress", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "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 vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "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 host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -130469,124 +131180,124 @@ "type": "long" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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", + "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 write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" }, { - "description": "the outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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", + "description": "the project name of the vm", + "name": "project", "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": "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 UUID of the latest async job acting on this object", - "name": "jobid", - "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": "publicip", + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, - {}, { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "State of the Service from LB rule", + "name": "servicestate", "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 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 group ID of the virtual machine", - "name": "groupid", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "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": "OS type id of the vm", - "name": "ostypeid", + "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 maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "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 count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "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", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { @@ -130594,65 +131305,85 @@ "name": "publicipid", "type": "string" }, + { + "description": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" + }, { "description": "the video RAM size in MB", "name": "videoram", "type": "long" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "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 account associated with the virtual machine", + "name": "account", "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": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", - "type": "boolean" + "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", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" + "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 ID of the virtual machine", @@ -130660,28 +131391,38 @@ "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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": "CPU arch of the VM", - "name": "arch", + "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "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": "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": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -130689,21 +131430,367 @@ "name": "diskkbswrite", "type": "long" }, - {}, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", - "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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "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 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 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" + }, + { + "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 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 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 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": "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", + "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 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": "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" + } + ], + "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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "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 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": "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": "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" + } + ], + "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 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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" + } + ], + "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 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 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 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" + } + ], + "type": "set" + } + ], + "type": "set" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "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 containing the user data", @@ -130711,152 +131798,134 @@ "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the name of the virtual machine", + "name": "name", + "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 backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the list of nics associated with vm", - "name": "nic", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" - }, - { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "resource type", + "name": "resourcetype", "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "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": "Type of adapter if available", - "name": "adaptertype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ { "description": "true if nic is default, false otherwise", "name": "isdefault", "type": "boolean" }, { - "description": "the ID of the nic", - "name": "id", + "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -130865,33 +131934,33 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the ID of the nic", + "name": "id", + "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the netmask of the nic", + "name": "netmask", "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 ID of the corresponding network", - "name": "networkid", - "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 NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { @@ -130900,526 +131969,178 @@ "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": "the name of the corresponding network", - "name": "networkname", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "Type of adapter if available", + "name": "adaptertype", "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": "IP addresses associated with NIC found for unmanaged VM", + "name": "ipaddresses", + "type": "list" + }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" }, { - "description": "tag value", - "name": "value", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the ID of the corresponding network", + "name": "networkid", "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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 project name where tag belongs to", - "name": "project", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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" } ], "type": "set" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "OS type id of the vm", + "name": "ostypeid", "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": "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", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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 name of the template for the virtual machine", - "name": "templatename", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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 name of the security group", - "name": "name", - "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": "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": "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": "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 name where tag belongs to", - "name": "project", - "type": "string" - } - ], - "type": "set" - }, - { - "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 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": "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": "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": "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": "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 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": "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": "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 starting IP of the security group rule", - "name": "startport", - "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", - "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" + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" } ] }, @@ -131429,16 +132150,17 @@ "name": "deleteManagementNetworkIpRange", "params": [ { - "description": "The vlan id the ip range sits on", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "vlan", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The starting IP address.", + "description": "The vlan id the ip range sits on", "length": 255, - "name": "startip", + "name": "vlan", "required": true, "type": "string" }, @@ -131450,22 +132172,20 @@ "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "description": "The starting IP address.", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "startip", "required": true, - "type": "uuid" + "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", @@ -131477,10 +132197,11 @@ "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.0" }, @@ -131490,33 +132211,33 @@ "name": "addKubernetesSupportedVersion", "params": [ { - "description": "the minimum number of CPUs to be set with the Kubernetes version", + "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, - "name": "mincpunumber", - "required": true, - "type": "integer" + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" }, { - "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", + "description": "the checksum value of the binaries 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": "arch", + "name": "checksum", "required": false, - "since": "4.20", "type": "string" }, { - "description": "the ID of the zone in which Kubernetes supported version will be available", + "description": "the minimum number of CPUs to be set with the Kubernetes version", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "name": "mincpunumber", + "required": true, + "type": "integer" }, { - "description": "the name of the Kubernetes supported version", + "description": "the CPU arch of the Kubernetes ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "name", + "name": "arch", "required": false, + "since": "4.20", "type": "string" }, { @@ -131526,13 +132247,6 @@ "required": true, "type": "string" }, - { - "description": "the checksum value of the binaries 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": "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, @@ -131541,6 +132255,13 @@ "since": "4.18.2", "type": "boolean" }, + { + "description": "the name of the Kubernetes supported version", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the URL of the binaries ISO for Kubernetes supported version", "length": 255, @@ -131556,37 +132277,37 @@ "type": "integer" } ], - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "response": [ { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, + {}, { - "description": "Name of the Kubernetes supported version", - "name": "name", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", - "type": "boolean" + "description": "Name of the Kubernetes supported version", + "name": "name", + "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, - {}, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { @@ -131594,11 +132315,10 @@ "name": "created", "type": "date" }, - {}, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { "description": "the id of the binaries ISO for Kubernetes supported version", @@ -131606,28 +132326,29 @@ "type": "string" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "Kubernetes semantic version", - "name": "semanticversion", - "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" }, { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", "type": "integer" }, { @@ -131636,19 +132357,19 @@ "type": "integer" }, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" + "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 id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" } ] }, @@ -131658,20 +132379,13 @@ "name": "registerCniConfiguration", "params": [ { - "description": "an optional project for the user data", + "description": "an optional domainId for the user data. 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 user data. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "Name of the user data", "length": 255, @@ -131680,51 +132394,58 @@ "type": "string" }, { - "description": "CNI Configuration content to be registered as User data", - "length": 1048576, - "name": "cniconfig", + "description": "comma separated list of variables declared in user data content", + "length": 255, + "name": "params", "required": false, "type": "string" }, { - "description": "comma separated list of variables declared in user data 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": "an optional domainId for the user data. If the account parameter is used, domainId must also be used.", + "description": "an optional project for the user data", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "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", + "description": "CNI Configuration content to be registered as User data", + "length": 1048576, + "name": "cniconfig", + "required": false, "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": "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.21.0" }, @@ -131733,14 +132454,6 @@ "isasync": false, "name": "linkUserDataToTemplate", "params": [ - { - "description": "the ID of the template for the virtual machine", - "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": false, - "type": "uuid" - }, { "description": "an optional override policy of the userdata. Possible values are - ALLOWOVERRIDE, APPEND, DENYOVERRIDE. Default policy is allowoverride", "length": 255, @@ -131749,97 +132462,40 @@ "type": "string" }, { - "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": "the ID of the ISO for the virtual machine", "length": 255, - "name": "userdataid", - "related": "", + "name": "isoid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" }, { - "description": "the ID of the ISO for the virtual machine", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "isoid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,linkUserDataToTemplate", "required": false, "type": "uuid" - } - ], - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the template display text", - "name": "displaytext", - "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": "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": "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": "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": "userdataid", + "related": "", + "required": false, + "type": "uuid" + } + ], + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "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" }, { @@ -131847,13 +132503,8 @@ "name": "tags", "response": [ { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -131862,66 +132513,61 @@ "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 project name where tag belongs to", - "name": "project", + "description": "id of the resource", + "name": "resourceid", "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": "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 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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { "description": "resource type", "name": "resourcetype", "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": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" - }, - { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { @@ -131929,77 +132575,86 @@ "name": "domainpath", "type": "string" }, - {}, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "description": "checksum of the template", + "name": "checksum", + "type": "string" }, { "description": "additional key/value details tied with template", "name": "details", "type": "map" }, + { + "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 id of userdata linked to this template", - "name": "userdataid", + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", - "type": "string" + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" }, - {}, { - "description": "the name of the zone for this template", - "name": "zonename", - "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": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "CPU Arch of the template", - "name": "arch", + "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", - "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 template ID", + "name": "id", "type": "string" }, + {}, { - "description": "the type of the template", - "name": "templatetype", - "type": "string" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { - "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 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": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "true if the template is managed across all Zones, false otherwise", @@ -132007,14 +132662,39 @@ "type": "boolean" }, { - "description": "the date this template was created", - "name": "created", - "type": "date" + "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 processor bit size", + "name": "bits", + "type": "int" + }, + { + "description": "the project name of the template", + "name": "project", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the ID of the secondary storage host for the template", + "name": "hostid", + "type": "string" + }, + { + "description": "the template name", + "name": "name", + "type": "string" + }, + { + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { "description": "the name of userdata linked to this template", @@ -132022,8 +132702,13 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + { + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { @@ -132032,94 +132717,130 @@ "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": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", + "type": "string" + }, + {}, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "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" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { - "description": "the template ID", - "name": "id", + "description": "the name of the zone for this template", + "name": "zonename", "type": "string" }, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", + "type": "string" }, { - "description": "the template name", - "name": "name", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, - {}, { - "description": "the project id of the template", - "name": "projectid", + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" + }, + { + "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 account id to which the template belongs", "name": "accountid", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "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 physical size of the template", + "name": "physicalsize", + "type": "long" + }, + { + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", "type": "boolean" } ], @@ -132131,129 +132852,88 @@ "name": "listCustomActions", "params": [ { - "description": "Name of the custom action", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "uuid of the custom action", + "description": "List actions whether they are enabled or not", "length": 255, - "name": "id", - "related": "listCustomActions", + "name": "enabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "uuid of the extension", "length": 255, - "name": "pagesize", + "name": "extensionid", + "related": "listExtensions,updateExtension", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "ID of a resource for actions", + "description": "Type of the resource for actions", "length": 255, - "name": "resourceid", + "name": "resourcetype", "required": false, "type": "string" }, { - "description": "uuid of the extension", + "description": "List by keyword", "length": 255, - "name": "extensionid", - "related": "listExtensions,updateExtension", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List actions whether they are enabled or not", + "description": "ID of a resource for actions", "length": 255, - "name": "enabled", + "name": "resourceid", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "Name of the custom action", "length": 255, - "name": "page", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { - "description": "Type of the resource for actions", + "description": "uuid of the custom action", "length": 255, - "name": "resourcetype", + "name": "id", + "related": "listCustomActions", "required": false, - "type": "string" + "type": "uuid" } ], "related": "", "response": [ - { - "description": "Whether the custom action is enabled or not", - "name": "enabled", - "type": "boolean" - }, - { - "description": "Name of the extension that this custom action belongs to", - "name": "extensionname", - "type": "string" - }, { "description": "ID of the extension that this custom action belongs to", "name": "extensionid", "type": "string" }, { - "description": "Creation timestamp of the custom action", - "name": "created", - "type": "date" - }, - { - "description": "Name of the custom action", - "name": "name", - "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", + "description": "Resource type for which the action is available", + "name": "resourcetype", "type": "string" }, {}, - {}, - { - "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", @@ -132268,24 +132948,64 @@ "description": "Name of the parameter", "name": "name", "type": "string" + }, + { + "description": "Comma-separated list of options for value of the parameter", + "name": "valueoptions", + "type": "list" + }, + { + "description": "Whether the parameter is required or not", + "name": "required", + "type": "boolean" } ], "type": "list" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "List of role types allowed for the custom action", + "name": "allowedroletypes", + "type": "list" + }, + { + "description": "Name of the custom action", + "name": "name", "type": "string" }, { - "description": "Resource type for which the action is available", - "name": "resourcetype", + "description": "Description of the custom action", + "name": "description", "type": "string" }, { - "description": "Specifies the timeout in seconds to wait for the action to complete before failing", - "name": "timeout", - "type": "integer" + "description": "Name of the extension that this custom action belongs to", + "name": "extensionname", + "type": "string" + }, + { + "description": "Whether the custom action is enabled or not", + "name": "enabled", + "type": "boolean" + }, + { + "description": "Message that will be used on failure during execution of the action", + "name": "errormessage", + "type": "string" + }, + { + "description": "Message that will be used on successful execution of the action", + "name": "successmessage", + "type": "string" + }, + { + "description": "Creation timestamp of the custom action", + "name": "created", + "type": "date" + }, + { + "description": "Details of the custom action", + "name": "details", + "type": "map" }, { "description": "ID of the custom action", @@ -132293,18 +133013,19 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Specifies the timeout in seconds to wait for the action to complete before failing", + "name": "timeout", "type": "integer" }, + {}, { - "description": "List of role types allowed for the custom action", - "name": "allowedroletypes", - "type": "list" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Message that will be used on failure during execution of the action", - "name": "errormessage", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ], @@ -132315,13 +133036,6 @@ "isasync": false, "name": "listGlobalLoadBalancerRules", "params": [ - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -132329,14 +133043,6 @@ "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": "List resources by tags (key/value pairs)", "length": 255, @@ -132345,26 +133051,26 @@ "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": "", "length": 255, - "name": "listall", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "region ID", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "regionid", + "name": "projectid", "related": "", "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": "list only resources belonging to the domain specified", @@ -132375,83 +133081,114 @@ "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "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": "", + "description": "the ID of the global load balancer rule", "length": 255, - "name": "pagesize", + "name": "id", + "related": "listGlobalLoadBalancerRules,updateGlobalLoadBalancerRule", + "required": false, + "type": "uuid" + }, + { + "description": "region ID", + "length": 255, + "name": "regionid", + "related": "", "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": "updateGlobalLoadBalancerRule", "response": [ + { + "description": "global load balancer rule ID", + "name": "id", + "type": "string" + }, + { + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", + "type": "string" + }, { "description": "the account of the load balancer rule", "name": "account", "type": "string" }, + {}, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "name of the global load balancer rule", + "name": "name", + "type": "string" + }, + { + "description": "DNS domain name given for the global load balancer", + "name": "gslbdomainname", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, {}, + { + "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": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "the private port", - "name": "privateport", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { - "description": "the account of the load balancer rule", - "name": "account", + "description": "the load balancer rule ID", + "name": "id", "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" }, { @@ -132459,13 +133196,18 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -132474,18 +133216,18 @@ "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 value", + "name": "value", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -132493,6 +133235,11 @@ "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", @@ -132502,28 +133249,18 @@ "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" } ], "type": "list" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "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" }, { @@ -132532,28 +133269,28 @@ "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", + "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": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the account of the load balancer rule", + "name": "account", "type": "string" }, { @@ -132562,13 +133299,18 @@ "type": "string" }, { - "description": "the name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the private port", + "name": "privateport", + "type": "string" + }, + { + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { @@ -132577,26 +133319,41 @@ "type": "boolean" }, { - "description": "the id of the zone the rule belongs to", - "name": "zoneid", + "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" } ], "type": "list" }, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "Region Id in which global load balancer is created", + "name": "regionid", "type": "integer" }, { - "description": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -132605,56 +133362,20 @@ "type": "string" }, { - "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" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" - }, - { - "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": "the description of the global load balancer rule", - "name": "description", + "description": "GSLB service type", + "name": "gslbservicetype", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" - }, - { - "description": "global load balancer rule ID", - "name": "id", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -132672,16 +133393,6 @@ } ], "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", @@ -132693,6 +133404,16 @@ "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" + }, {} ] }, @@ -132711,9 +133432,11 @@ } ], "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" }, { @@ -132726,11 +133449,9 @@ "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" } ] @@ -132751,33 +133472,33 @@ ], "related": "", "response": [ + {}, + {}, { - "description": "Name of the container cluster", - "name": "name", + "description": "the config data of the cluster", + "name": "configdata", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the container cluster", + "name": "name", "type": "string" }, - {}, { "description": "the id of the container cluster", "name": "id", "type": "string" }, { - "description": "the config data of the cluster", - "name": "configdata", + "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" - }, - {} + } ] }, { @@ -132800,11 +133521,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", @@ -132816,6 +133532,11 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "true if operation is executed successfully", + "name": "success", + "type": "boolean" + }, {} ] }, @@ -132834,6 +133555,11 @@ } ], "response": [ + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, {}, {}, { @@ -132850,11 +133576,6 @@ "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.9.0" @@ -132874,27 +133595,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": "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" } ] }, @@ -132904,27 +133625,57 @@ "name": "listInternalLoadBalancerVMs", "params": [ { - "description": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "fetchhealthcheckresults", + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "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, - "since": "4.14", "type": "boolean" }, { - "description": "List Internal LB VMs by VPC", + "description": "", "length": 255, - "name": "vpcid", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "the Pod ID of the Internal LB VM", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "the state of the Internal LB VM", + "description": "the ID of the Internal LB VM", "length": 255, - "name": "state", + "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,createVMFromBackup,importVm", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { "description": "the Zone ID of the Internal LB VM", @@ -132935,42 +133686,40 @@ "type": "uuid" }, { - "description": "list by network 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": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "the state of the Internal LB VM", "length": 255, - "name": "page", + "name": "state", "required": false, - "type": "integer" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "description": "list by network id", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "if true is passed for this parameter, list only VPC Internal LB VMs", "length": 255, - "name": "account", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { "description": "the host ID of the Internal LB VM", @@ -132988,102 +133737,151 @@ "type": "string" }, { - "description": "if true is passed for this parameter, list only VPC Internal LB VMs", + "description": "List Internal LB VMs by VPC", "length": 255, - "name": "forvpc", + "name": "vpcid", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "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": "if true is passed for this parameter, also fetch last executed health check results for the VM. Default is false", "length": 255, - "name": "isrecursive", + "name": "fetchhealthcheckresults", "required": false, + "since": "4.14", "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" + } + ], + "related": "listRouters", + "response": [ + { + "description": "the hostname for the router", + "name": "hostname", + "type": "string" + }, + { + "description": "the link local netmask for the router", + "name": "linklocalnetmask", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" + }, + { + "description": "the domain associated with the router", + "name": "domain", + "type": "string" + }, + { + "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": "result of the health check if available", + "name": "success", + "type": "boolean" + }, + { + "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": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" + } + ], + "type": "list" }, { - "description": "the ID of the Internal LB VM", - "length": 255, - "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": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" }, { - "description": "the Pod ID of the Internal LB VM", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", + "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": "role of the domain router", + "name": "role", + "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - } - ], - "related": "listRouters", - "response": [ - { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "the Pod ID for the router", + "name": "podid", "type": "string" }, { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the project name of the address", + "name": "project", "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 version of template", - "name": "version", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "CPU arch of the router", + "name": "arch", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the Domain the router belongs to", - "name": "domainpath", + "description": "the Zone name for the router", + "name": "zonename", "type": "string" }, { - "description": "the guest netmask for the router", - "name": "guestnetmask", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the version of scripts", + "name": "scriptsversion", "type": "string" }, { @@ -133092,28 +133890,28 @@ "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" + "description": "if this router is an redundant virtual router", + "name": "isredundantrouter", + "type": "boolean" }, { - "description": "the domain associated with the router", - "name": "domain", + "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", + "description": "the public IP address for the router", + "name": "publicip", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the account associated with the router", + "name": "account", "type": "string" }, { - "description": "the host ID for the router", - "name": "hostid", + "description": "the link local IP address for the router", + "name": "linklocalip", "type": "string" }, { @@ -133122,94 +133920,109 @@ "type": "boolean" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { - "description": "the state of the router", - "name": "state", - "type": "state" + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" }, { - "description": "VPC the router belongs to", - "name": "vpcid", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "true if any health checks had failed", - "name": "healthchecksfailed", - "type": "boolean" + "description": "the version of template", + "name": "version", + "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "VPC the router belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the Pod ID for the router", - "name": "podid", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the Zone ID for the router", + "name": "zoneid", "type": "string" }, { - "description": "if this router is an redundant virtual router", - "name": "isredundantrouter", - "type": "boolean" + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", + "type": "string" }, { - "description": "CPU arch of the router", - "name": "arch", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the public MAC address for the router", - "name": "publicmacaddress", + "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 router", + "name": "id", "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "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 date and time the router was created", + "name": "created", + "type": "date" }, { - "description": "the template ID for the router", - "name": "templateid", + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", "type": "string" }, {}, { - "description": "role of the domain router", - "name": "role", + "description": "the guest netmask for the router", + "name": "guestnetmask", "type": "string" }, { - "description": "the hostname for the router", - "name": "hostname", + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the Pod name for the router", + "name": "podname", "type": "string" }, { @@ -133217,58 +134030,53 @@ "name": "nic", "response": [ { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "description": "the name of the corresponding network", - "name": "networkname", - "type": "string" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the ID of the nic", + "name": "id", "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 isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "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": "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { @@ -133277,58 +134085,53 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "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", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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": "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 type if available", - "name": "isolatedpvlantype", + "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": "the cidr of IPv6 network", - "name": "ip6cidr", + "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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -133337,113 +134140,61 @@ "type": "integer" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the ID of the corresponding network", + "name": "networkid", "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "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": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the health check on the router", - "name": "checkname", + "description": "the gateway of the nic", + "name": "gateway", "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", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "detailed response generated on running health check", - "name": "details", - "type": "string" + "description": "true if nic is default, false otherwise", + "name": "isdefault", + "type": "boolean" } ], - "type": "list" - }, - { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the network domain for the router", - "name": "networkdomain", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the date and time the router was created", - "name": "created", - "type": "date" + "type": "set" }, { - "description": "the public IP address for the router", - "name": "publicip", - "type": "string" + "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 template name for the router", + "name": "templatename", "type": "string" }, { @@ -133452,13 +134203,13 @@ "type": "string" }, { - "description": "the Pod name for the router", - "name": "podname", + "description": "the public MAC address for the router", + "name": "publicmacaddress", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the public netmask for the router", + "name": "publicnetmask", "type": "string" }, { @@ -133466,52 +134217,27 @@ "name": "jobstatus", "type": "integer" }, + {}, { - "description": "the account associated with the router", - "name": "account", - "type": "string" - }, - { - "description": "the project name of the address", - "name": "project", - "type": "string" - }, - { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" - }, - { - "description": "the Zone name for the router", - "name": "zonename", - "type": "string" - }, - { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the id of the router", - "name": "id", + "description": "the ID of the corresponding link local network", + "name": "linklocalnetworkid", "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 link local netmask for the router", - "name": "linklocalnetmask", - "type": "string" + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" }, { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" - }, - {} + } ] }, { @@ -133526,6 +134252,14 @@ "required": false, "type": "integer" }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "List by keyword", "length": 255, @@ -133540,14 +134274,6 @@ "required": false, "type": "integer" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "Cisco VNMC resource ID", "length": 255, @@ -133561,11 +134287,8 @@ "response": [ {}, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, + {}, + {}, {}, {}, { @@ -133574,8 +134297,11 @@ "type": "integer" }, {}, - {}, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -133601,48 +134327,48 @@ ], "related": "", "response": [ - {}, - { - "description": "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": "List of migrations", "name": "migrations", "type": "list" }, + { + "description": "Start event Id of the DRS Plan", + "name": "eventid", + "type": "string" + }, { "description": "Status of DRS Plan", "name": "status", "type": "status" }, { - "description": "Start event Id of the DRS Plan", - "name": "eventid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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" }, + { + "description": "Type of DRS Plan (Automated or Manual))", + "name": "type", + "type": "type" + }, { "description": "unique ID of the drs plan for cluster", "name": "id", "type": "string" }, + { + "description": "Id of the cluster", + "name": "clusterid", + "type": "string" + }, {} ], "since": "4.19.0" @@ -133662,6 +134388,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", @@ -133673,16 +134405,10 @@ "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": "3.0.0" @@ -133693,11 +134419,11 @@ "name": "uploadResourceIcon", "params": [ { - "description": "Base64 string representation of the resource icon/image", - "length": 2097152, - "name": "base64image", + "description": "list of resources to upload the icon/image for", + "length": 255, + "name": "resourceids", "required": true, - "type": "string" + "type": "list" }, { "description": "type of the resource", @@ -133707,11 +134433,11 @@ "type": "string" }, { - "description": "list of resources to upload the icon/image for", - "length": 255, - "name": "resourceids", + "description": "Base64 string representation of the resource icon/image", + "length": 2097152, + "name": "base64image", "required": true, - "type": "list" + "type": "string" } ], "response": [ @@ -133720,12 +134446,12 @@ "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": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -133733,8 +134459,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" } ], @@ -133756,21 +134482,16 @@ "description": "the ID of the Kubernetes supported version", "length": 255, "name": "id", - "related": "listKubernetesSupportedVersions,updateKubernetesSupportedVersion", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions,updateKubernetesSupportedVersion", "required": true, "type": "uuid" } ], - "related": "listKubernetesSupportedVersions", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { @@ -133779,55 +134500,33 @@ "type": "boolean" }, { - "description": "the minimum RAM size in MB needed for the Kubernetes supported version", - "name": "minmemory", - "type": "integer" - }, - { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, - { - "description": "the id of the binaries ISO for Kubernetes supported version", - "name": "isoid", - "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 state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the id of the Kubernetes supported version", "name": "id", "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 date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, { @@ -133841,9 +134540,15 @@ "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" + }, + {}, + { + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, { "description": "the UUID of the latest async job acting on this object", @@ -133851,8 +134556,29 @@ "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", + "type": "string" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, + {}, + { + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" + }, + { + "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" } ] @@ -133872,16 +134598,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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, {}, { "description": "true if operation is executed successfully", @@ -133890,8 +134616,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" } ], @@ -133903,58 +134629,58 @@ "name": "createGuestNetworkIpv6Prefix", "params": [ { - "description": "UUID of zone to which the IPv6 prefix belongs to.", + "description": "The /56 or higher IPv6 CIDR for network prefix.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "prefix", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "The /56 or higher IPv6 CIDR for network prefix.", + "description": "UUID of zone to which the IPv6 prefix belongs to.", "length": 255, - "name": "prefix", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" } ], "related": "listGuestNetworkIpv6Prefixes", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "count of the used IPv6 subnets for the prefix.", + "name": "usedsubnets", + "type": "integer" + }, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", "type": "string" }, + {}, + {}, { - "description": "id of the guest IPv6 prefix", - "name": "id", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "id of the guest IPv6 prefix", + "name": "id", "type": "string" }, - {}, { - "description": "count of the used IPv6 subnets for the prefix.", - "name": "usedsubnets", + "description": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", "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": "count of the available IPv6 subnets for the prefix.", - "name": "availablesubnets", + "description": "count of the total IPv6 subnets for the prefix.", + "name": "totalsubnets", "type": "integer" }, { @@ -133963,9 +134689,9 @@ "type": "date" }, { - "description": "count of the total IPv6 subnets for the prefix.", - "name": "totalsubnets", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" } ], "since": "4.17.0.0" @@ -133975,6 +134701,13 @@ "isasync": false, "name": "createRole", "params": [ + { + "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "length": 255, + "name": "type", + "required": false, + "type": "string" + }, { "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private). Default is true.", "length": 255, @@ -133990,30 +134723,28 @@ "type": "string" }, { - "description": "The description of the role", + "description": "ID of the role to be cloned from. Either roleid or type must be passed in", "length": 255, - "name": "description", + "name": "roleid", + "related": "createRole,listRoles,updateRole", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "The type of the role, valid options are: Admin, ResourceAdmin, DomainAdmin, User", + "description": "The description of the role", "length": 255, - "name": "type", + "name": "description", "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", "response": [ + { + "description": "the ID of the role", + "name": "id", + "type": "string" + }, { "description": "the type of the role", "name": "type", @@ -134024,6 +134755,12 @@ "name": "isdefault", "type": "boolean" }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the state of the role", "name": "state", @@ -134034,9 +134771,10 @@ "name": "ispublic", "type": "boolean" }, + {}, { - "description": "the ID of the role", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -134044,22 +134782,10 @@ "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 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" @@ -134069,13 +134795,6 @@ "isasync": false, "name": "getUploadParamsForVolume", "params": [ - { - "description": "Image store uuid", - "length": 255, - "name": "imagestoreuuid", - "required": false, - "type": "string" - }, { "description": "the name of the volume/template/iso", "length": 255, @@ -134084,17 +134803,18 @@ "type": "string" }, { - "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", - "required": true, - "type": "string" + "name": "projectid", + "related": "", + "required": false, + "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" }, { @@ -134105,28 +134825,26 @@ "type": "string" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "description": "Upload volume/template/iso for the project", + "description": "Image store uuid", "length": 255, - "name": "projectid", - "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 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": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" + "name": "checksum", + "required": false, + "type": "string" }, { "description": "the ID of the disk offering. This must be a custom sized offering since during upload of volume/template size is unknown.", @@ -134135,6 +134853,14 @@ "related": "", "required": false, "type": "uuid" + }, + { + "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" } ], "related": "getUploadParamsForTemplate,getUploadParamsForIso", @@ -134145,36 +134871,36 @@ "type": "string" }, { - "description": "encrypted data to be sent in the POST request.", - "name": "metadata", + "description": "the timestamp after which the signature expires", + "name": "expires", "type": "string" }, { - "description": "the timestamp after which the signature expires", - "name": "expires", + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, + { + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, - {}, - { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" } ], "since": "4.6.0" @@ -134185,12 +134911,21 @@ "name": "updateAutoScaleVmProfile", "params": [ { - "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", + "description": "the service offering of the auto deployed virtual machine", "length": 255, - "name": "customid", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.4", - "type": "string" + "since": "4.18.0", + "type": "uuid" + }, + { + "description": "the ID of the user used to launch and destroy the VMs", + "length": 255, + "name": "autoscaleuserid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": false, + "type": "uuid" }, { "description": "the ID of the autoscale vm profile", @@ -134201,68 +134936,51 @@ "type": "uuid" }, { - "description": "the time allowed for existing connections to get closed before a vm is destroyed", - "length": 255, - "name": "expungevmgraceperiod", - "required": false, - "type": "integer" - }, - { - "description": "the ID of the userdata", + "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": "userdataid", - "related": "", + "name": "otherdeployparams", "required": false, - "since": "4.18.1", - "type": "uuid" + "since": "4.18.0", + "type": "map" }, { "description": "the template of the auto deployed virtual machine", "length": 255, "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "type": "uuid" }, { - "description": "an optional field, whether to the display the profile 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" - }, - { - "description": "the service offering of the auto deployed virtual machine", - "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": false, - "since": "4.18.0", - "type": "uuid" + "type": "string" }, { - "description": "the ID of the user used to launch and destroy the VMs", + "description": "the time allowed for existing connections to get closed before a vm is destroyed", "length": 255, - "name": "autoscaleuserid", - "related": "disableUser,getUser,listUsers,lockUser", + "name": "expungevmgraceperiod", "required": false, - "type": "uuid" + "type": "integer" }, { - "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" }, { - "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": "an optional field, whether to the display the profile to the end user or not", "length": 255, - "name": "otherdeployparams", + "name": "fordisplay", "required": false, - "since": "4.18.0", - "type": "map" + "since": "4.4", + "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", @@ -134273,40 +134991,43 @@ "type": "string" }, { - "description": "used to specify the parameters values for the variables in userdata.", + "description": "the ID of the userdata", "length": 255, - "name": "userdatadetails", + "name": "userdataid", + "related": "", "required": false, "since": "4.18.1", + "type": "uuid" + }, + { + "description": "counterparam list. Example: counterparam[0].name=snmpcommunity&counterparam[0].value=public&counterparam[1].name=snmpport&counterparam[1].value=161", + "length": 255, + "name": "counterparam", + "required": false, "type": "map" } ], "related": "listAutoScaleVmProfiles", "response": [ - { - "description": "the autoscale vm profile ID", - "name": "id", - "type": "string" - }, { "description": "the project id vm profile", "name": "projectid", "type": "string" }, - {}, { - "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", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { @@ -134314,42 +135035,29 @@ "name": "expungevmgraceperiod", "type": "integer" }, - {}, { "description": "Base64 encoded VM user data", "name": "userdata", "type": "string" }, - {}, - { - "description": "the project name of the vm profile", - "name": "project", - "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": "the domain name of the vm profile", - "name": "domain", + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "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", + "description": "the autoscale vm profile ID", + "name": "id", "type": "string" }, { @@ -134357,9 +135065,10 @@ "name": "fordisplay", "type": "boolean" }, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the account owning the instance group", + "name": "account", "type": "string" }, { @@ -134368,28 +135077,45 @@ "type": "map" }, { - "description": "path of the domain to which the vm profile belongs", - "name": "domainpath", + "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": "the template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, + {}, { "description": "the service offering to be used while deploying a virtual machine", "name": "serviceofferingid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template to be used while deploying a virtual machine", - "name": "templateid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the project name of the vm profile", + "name": "project", + "type": "string" + }, + { + "description": "the domain name of the vm profile", + "name": "domain", + "type": "string" + }, + { + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" } ] @@ -134411,150 +135137,150 @@ "related": "", "response": [ { - "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 date when this vm group was created", - "name": "created", - "type": "date" + "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 autoscale vm group ID", + "name": "id", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 public ip address", + "name": "publicip", + "type": "string" }, { - "description": "the project name of the vm group", - "name": "project", - "type": "string" + "description": "the date when this vm group was created", + "name": "created", + "type": "date" }, - {}, { - "description": "the domain name of the vm group", - "name": "domain", - "type": "string" + "description": "list of scaleup autoscale policies", + "name": "scaleuppolicies", + "type": "list" }, { - "description": "the current state of the AutoScale Vm Group", - "name": "state", + "description": "the private port", + "name": "privateport", "type": "string" }, { - "description": "the autoscale vm group ID", - "name": "id", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the name of the guest network the lb rule belongs to", - "name": "associatednetworkname", + "description": "the project id of the vm group", + "name": "projectid", "type": "string" }, { - "description": "path of the domain to which the vm group belongs", - "name": "domainpath", + "description": "the project name of the vm group", + "name": "project", "type": "string" }, { - "description": "the autoscale profile that contains information about the vms in the vm group.", - "name": "vmprofileid", + "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": "the public ip address", - "name": "publicip", + "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": "the load balancer rule ID", + "name": "lbruleid", + "type": "string" }, { - "description": "the account owning the vm group", - "name": "account", - "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 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 ID of the vm group", - "name": "domainid", - "type": "string" + "description": "list of scaledown autoscale policies", + "name": "scaledownpolicies", + "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 lb provider of the guest network the lb rule belongs to", - "name": "lbprovider", - "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": "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 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", + "description": "the number of available virtual machines (in Running, Starting, Stopping or Migrating state) in the vmgroup", + "name": "availablevirtualmachinecount", "type": "int" }, { - "description": "the name of the autoscale vm group ", - "name": "name", + "description": "the domain name of the vm group", + "name": "domain", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the account owning the vm group", + "name": "account", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "lbruleid", + "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": "is group for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the project id of the vm group", - "name": "projectid", + "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": "list of scaledown autoscale policies", - "name": "scaledownpolicies", - "type": "list" + "description": "the id of the guest network the lb rule belongs to", + "name": "associatednetworkid", + "type": "string" }, - {}, { - "description": "the public port", - "name": "publicport", + "description": "the current state of the AutoScale Vm Group", + "name": "state", "type": "string" } ] @@ -134565,19 +135291,11 @@ "name": "listGuestNetworkIpv6Prefixes", "params": [ { - "description": "UUID of the IPv6 prefix.", - "length": 255, - "name": "id", - "related": "listGuestNetworkIpv6Prefixes", - "required": false, - "type": "uuid" - }, - { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "", @@ -134595,25 +135313,27 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "UUID of the IPv6 prefix.", "length": 255, - "name": "keyword", + "name": "id", + "related": "listGuestNetworkIpv6Prefixes", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "guest IPv6 prefix", - "name": "prefix", - "type": "string" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": " date when this IPv6 prefix was created.", + "name": "created", + "type": "date" }, { "description": "count of the used IPv6 subnets for the prefix.", @@ -134621,13 +135341,8 @@ "type": "integer" }, { - "description": " date when this IPv6 prefix was created.", - "name": "created", - "type": "date" - }, - { - "description": "id of zone to which the IPv6 prefix belongs to.", - "name": "zoneid", + "description": "guest IPv6 prefix", + "name": "prefix", "type": "string" }, { @@ -134635,21 +135350,32 @@ "name": "jobid", "type": "string" }, + {}, + { + "description": "id of zone to which the IPv6 prefix belongs to.", + "name": "zoneid", + "type": "string" + }, + {}, { "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", + "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": "count of the available IPv6 subnets for the prefix.", + "name": "availablesubnets", + "type": "integer" } ], "since": "4.17.0" @@ -134659,6 +135385,13 @@ "isasync": true, "name": "updateGuestOsMapping", "params": [ + { + "description": "Hypervisor specific name for this Guest OS", + "length": 255, + "name": "osnameforhypervisor", + "required": true, + "type": "string" + }, { "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, @@ -134674,38 +135407,29 @@ "related": "updateGuestOsMapping", "required": true, "type": "uuid" - }, - { - "description": "Hypervisor specific name for this Guest OS", - "length": 255, - "name": "osnameforhypervisor", - "required": true, - "type": "string" } ], "related": "", "response": [ { - "description": "the hypervisor", - "name": "hypervisor", + "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 Guest OS mapping", + "name": "id", + "type": "string" }, - {}, { - "description": "the ID of the Guest OS type", - "name": "ostypeid", + "description": "hypervisor specific name for the Guest OS", + "name": "osnameforhypervisor", "type": "string" }, - {}, { - "description": "the ID of the Guest OS mapping", - "name": "id", - "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", @@ -134717,21 +135441,23 @@ "name": "osdisplayname", "type": "string" }, + {}, { - "description": "hypervisor specific name for the Guest OS", - "name": "osnameforhypervisor", + "description": "the hypervisor", + "name": "hypervisor", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the Guest OS type", + "name": "ostypeid", "type": "string" }, { "description": "is the mapping user defined", "name": "isuserdefined", "type": "string" - } + }, + {} ], "since": "4.4.0" }, @@ -134758,27 +135484,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": "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" }, - { - "description": "true if operation is executed successfully", - "name": "success", - "type": "boolean" - } + {} ] }, { @@ -134787,10 +135513,10 @@ "name": "updateHostPassword", "params": [ { - "description": "the host ID", + "description": "the cluster ID", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "clusterid", + "related": "addCluster,updateCluster", "required": false, "type": "uuid" }, @@ -134802,10 +135528,10 @@ "type": "string" }, { - "description": "the cluster ID", + "description": "the host ID", "length": 255, - "name": "clusterid", - "related": "addCluster,updateCluster", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, @@ -134826,27 +135552,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 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" - } + }, + {} ] }, { @@ -134855,18 +135581,10 @@ "name": "createPortableIpRange", "params": [ { - "description": "Id of the Region", - "length": 255, - "name": "regionid", - "related": "", - "required": true, - "type": "integer" - }, - { - "description": "the gateway for the portable IP range", + "description": "VLAN id, if not specified defaulted to untagged", "length": 255, - "name": "gateway", - "required": true, + "name": "vlan", + "required": false, "type": "string" }, { @@ -134884,87 +135602,48 @@ "type": "string" }, { - "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" }, { - "description": "VLAN id, if not specified defaulted to untagged", + "description": "Id of the Region", "length": 255, - "name": "vlan", - "required": false, - "type": "string" - } - ], - "related": "", - "response": [ - { - "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", + "related": "", + "required": true, "type": "integer" }, - {}, - { - "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": "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" - }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "description": "the netmask of the portable IP range", + "length": 255, + "name": "netmask", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "List of portable IP and association with zone/network/vpc details that are part of GSLB rule", "name": "portableipaddress", "response": [ { - "description": "date the portal IP address was acquired", - "name": "allocated", - "type": "date" + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", + "name": "state", + "type": "string" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "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": "the account ID the portable IP address is associated with", @@ -134972,38 +135651,85 @@ "type": "string" }, { - "description": "State of the ip address. Can be: Allocating, Allocated, Releasing and Free", - "name": "state", + "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": "the domain ID the portable IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the ID of the zone the public IP address belongs to", - "name": "zoneid", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "Region Id in which global load balancer is created", - "name": "regionid", - "type": "integer" + "description": "VPC the ip belongs to", + "name": "vpcid", + "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": "VPC the ip belongs to", - "name": "vpcid", - "type": "string" + "description": "date the portal IP address was acquired", + "name": "allocated", + "type": "date" } ], "type": "list" - } + }, + {}, + { + "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" + }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the start ip of the portable IP range", + "name": "startip", + "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 gateway of the VLAN IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the end ip of the portable IP range", + "name": "endip", + "type": "string" + }, + {} ], "since": "4.2.0" }, @@ -135013,19 +135739,19 @@ "name": "deleteWebhookDelivery", "params": [ { - "description": "The ID of the management server", + "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": "managementserverid", - "related": "", + "name": "enddate", "required": false, - "type": "uuid" + "type": "date" }, { - "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 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.", @@ -135052,27 +135778,27 @@ } ], "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", + "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.20.0" @@ -135083,26 +135809,27 @@ "name": "updateCluster", "params": [ { - "description": "the ID of the Cluster", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "id", - "related": "addCluster,updateCluster", - "required": true, - "type": "uuid" + "name": "arch", + "required": false, + "since": "4.20", + "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "managedstate", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "hypervisor type of the cluster", + "description": "the ID of the Cluster", "length": 255, - "name": "clustertype", - "required": false, - "type": "string" + "name": "id", + "related": "addCluster,updateCluster", + "required": true, + "type": "uuid" }, { "description": "the cluster name", @@ -135112,71 +135839,110 @@ "type": "string" }, { - "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" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "hypervisor type of the cluster", "length": 255, - "name": "allocationstate", + "name": "clustertype", "required": false, "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", + "description": "hypervisor type of the cluster", "length": 255, - "name": "externaldetails", + "name": "hypervisor", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { - "description": "hypervisor type of the cluster", + "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": "hypervisor", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" } ], "related": "addCluster", "response": [ + {}, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "the type of the cluster", + "name": "clustertype", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", + "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 hypervisor type of the cluster", + "name": "hypervisortype", "type": "string" }, - {}, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the total capacity available", - "name": "capacitytotal", + "description": "the capacity currently in use", + "name": "capacityused", "type": "long" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { @@ -135185,13 +135951,8 @@ "type": "short" }, { - "description": "the Zone name", - "name": "zonename", - "type": "string" - }, - { - "description": "the Cluster name", - "name": "clustername", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -135200,28 +135961,44 @@ "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Pod name", + "name": "podname", "type": "string" } ], "type": "list" }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + {}, + { + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, { "description": "the Pod name of the cluster", "name": "podname", @@ -135233,24 +136010,34 @@ "type": "string" }, { - "description": "the Zone ID of the cluster", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", "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 type of the cluster", - "name": "clustertype", + "description": "the Pod ID of the cluster", + "name": "podid", + "type": "string" + }, + { + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "type": "string" }, { @@ -135259,82 +136046,175 @@ "type": "map" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "the Zone ID of the cluster", + "name": "zoneid", "type": "string" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - }, + } + ] + }, + { + "description": "Update the extension", + "isasync": false, + "name": "updateExtension", + "params": [ { - "description": "the Pod ID of the cluster", - "name": "podid", + "description": "State of the extension", + "length": 255, + "name": "state", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Description of the extension", + "length": 255, + "name": "description", + "required": false, "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", - "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": "The name of extension for this cluster", - "name": "extensionname", - "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": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "Optional boolean field, which indicates if details should be cleaned up or not (If set to true, details removed for this extension, details field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupdetails", + "required": false, + "type": "boolean" + }, + { + "description": "The ID of the extension", + "length": 255, + "name": "id", + "related": "listExtensions,updateExtension", + "required": true, + "type": "uuid" + } + ], + "related": "listExtensions", + "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": "ID of the extension", + "name": "id", "type": "string" }, { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", + "description": "The details of the extension", + "name": "details", + "type": "map" + }, + { + "description": "The state of the extension", + "name": "state", "type": "string" }, + {}, { - "description": "the cluster name", - "name": "name", + "description": "Type of the extension", + "name": "type", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "List of resources to which extension is registered to", + "name": "resources", + "response": [ + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "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 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": "Creation timestamp of the extension", + "name": "created", + "type": "date" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "Removal timestamp of the extension, if applicable", + "name": "removed", + "type": "date" + }, + { + "description": "Name of the extension", + "name": "name", "type": "string" }, + { + "description": "True if the extension path is in ready state across management servers", + "name": "pathready", + "type": "boolean" + }, {}, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "Description of the extension", + "name": "description", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "The path of the entry point fo the extension", + "name": "path", "type": "string" } - ] + ], + "since": "4.21.0" }, { "description": "Lists the VMs in a VMware Datacenter", @@ -135342,16 +136222,17 @@ "name": "listVmwareDcVms", "params": [ { - "description": "", + "description": "UUID of a linked existing vCenter", "length": 255, - "name": "page", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "The name/ip of vCenter. Make sure it is IP address or full qualified domain name for host running vCenter server.", + "description": "The Username required to connect to resource.", "length": 255, - "name": "vcenter", + "name": "username", "required": false, "type": "string" }, @@ -135363,24 +136244,23 @@ "type": "integer" }, { - "description": "The Username required to connect to resource.", + "description": "List by keyword", "length": 255, - "name": "username", + "name": "keyword", "required": false, "type": "string" }, { - "description": "UUID of a linked existing vCenter", + "description": "", "length": 255, - "name": "existingvcenterid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "The password for specified username.", + "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": "password", + "name": "vcenter", "required": false, "type": "string" }, @@ -135392,9 +136272,9 @@ "type": "string" }, { - "description": "Name of VMware datacenter.", + "description": "The password for specified username.", "length": 255, - "name": "datacentername", + "name": "password", "required": false, "type": "string" }, @@ -135406,23 +136286,38 @@ "type": "string" }, { - "description": "List by keyword", + "description": "Name of VMware datacenter.", "length": 255, - "name": "keyword", + "name": "datacentername", "required": false, "type": "string" } ], "related": "listUnmanagedInstances", "response": [ + { + "description": "the memory of the virtual machine in MB", + "name": "memory", + "type": "integer" + }, { "description": "indicates the boot mode", "name": "bootmode", "type": "string" }, { - "description": "the power state of the virtual machine", - "name": "powerstate", + "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 operating system ID of the virtual machine", + "name": "osid", "type": "string" }, { @@ -135436,102 +136331,114 @@ "type": "string" }, { - "description": "the operating system ID of the virtual machine", - "name": "osid", + "description": "the power state of the virtual machine", + "name": "powerstate", "type": "string" }, { - "description": "the list of nics associated with the virtual machine", - "name": "nic", + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "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 broadcast uri of the nic", - "name": "broadcasturi", - "type": "string" - }, - { - "description": "the ID of the nic", - "name": "id", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "MTU configured on the NIC", - "name": "mtu", + "description": "the position of the disk", + "name": "position", "type": "integer" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the controller of the disk", + "name": "datastoretype", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the file path of the disk image", + "name": "imagepath", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the controller of the disk", + "name": "datastorename", + "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", + "type": "integer" + }, + { + "description": "the list of nics associated with the virtual machine", + "name": "nic", + "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "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 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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -135540,13 +136447,8 @@ "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", - "type": "string" - }, - { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -135554,24 +136456,14 @@ "name": "isolatedpvlan", "type": "integer" }, - { - "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": "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -135580,120 +136472,111 @@ "type": "boolean" }, { - "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 gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "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", + "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": "the memory of the virtual machine in MB", - "name": "memory", - "type": "integer" - }, - {}, - { - "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 controller of the disk", - "name": "datastorename", + "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the Secondary ipv4 addr of nic", + "name": "secondaryip", + "type": "list" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "the ID of the corresponding network", + "name": "networkid", "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 ID of the disk", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the ID of the nic", "name": "id", "type": "string" }, { - "description": "the position of the disk", - "name": "position", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the controller unit of the disk", - "name": "controllerunit", - "type": "integer" + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the controller of the disk", - "name": "controller", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorepath", + "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" } ], "type": "set" }, { - "description": "indicates the boot type", - "name": "boottype", - "type": "string" - }, - { - "description": "the ID of the host to which virtual machine belongs", - "name": "hostid", - "type": "string" - }, - {}, - { - "description": "the name of the cluster to which virtual machine belongs", - "name": "clustername", + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", "type": "string" }, { @@ -135702,20 +136585,17 @@ "type": "integer" }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", "type": "string" }, + {}, + {}, { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "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", @@ -135723,172 +136603,11 @@ } ] }, - { - "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": "Only honored when type is Orchestrator. Whether prepare VM is needed or not", - "length": 255, - "name": "orchestratorrequirespreparevm", - "required": false, - "type": "boolean" - }, - { - "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 path of the entry point fo the extension", - "name": "path", - "type": "string" - }, - {}, - { - "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.", "isasync": false, "name": "listStorageProviders", "params": [ - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, { "description": "", "length": 255, @@ -135903,6 +136622,13 @@ "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the type of storage provider: either primary or image", "length": 255, @@ -135914,27 +136640,27 @@ "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the type of the storage provider: primary or image provider", + "name": "type", "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } + }, + {} ] }, { @@ -135943,11 +136669,12 @@ "name": "listUcsProfiles", "params": [ { - "description": "", + "description": "the id for the ucs manager", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "ucsmanagerid", + "related": "", + "required": true, + "type": "uuid" }, { "description": "List by keyword", @@ -135964,17 +136691,15 @@ "type": "integer" }, { - "description": "the id for the ucs manager", + "description": "", "length": 255, - "name": "ucsmanagerid", - "related": "", - "required": true, - "type": "uuid" + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -135985,12 +136710,13 @@ "name": "ucsdn", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - {} + } ] }, { @@ -136010,13 +136736,14 @@ "related": "", "response": [ { - "description": "the api key of the registered user", - "name": "apikey", + "description": "the secret key of the registered user", + "name": "secretkey", "type": "string" }, + {}, { - "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" }, {}, @@ -136025,16 +136752,15 @@ "name": "jobstatus", "type": "integer" }, - {}, + { + "description": "the api key of the registered user", + "name": "apikey", + "type": "string" + }, { "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", - "type": "string" } ], "since": "4.10.0" @@ -136044,6 +136770,13 @@ "isasync": true, "name": "updateGlobalLoadBalancerRule", "params": [ + { + "description": "session sticky method (sourceip) if not specified defaults to sourceip", + "length": 255, + "name": "gslbstickysessionmethodname", + "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'", "length": 255, @@ -136052,9 +136785,9 @@ "type": "string" }, { - "description": "session sticky method (sourceip) if not specified defaults to sourceip", - "length": 255, - "name": "gslbstickysessionmethodname", + "description": "the description of the load balancer rule", + "length": 4096, + "name": "description", "required": false, "type": "string" }, @@ -136065,91 +136798,93 @@ "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": "the description of the global load balancer rule", - "name": "description", - "type": "string" - }, - { - "description": "the project id of the load balancer", - "name": "projectid", - "type": "string" + "description": "Region Id in which global load balancer is created", + "name": "regionid", + "type": "integer" }, { - "description": "the project name of the load balancer", - "name": "project", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "global load balancer rule ID", - "name": "id", + "description": "the description of the global load balancer rule", + "name": "description", "type": "string" }, { - "description": "name of the global load balancer rule", - "name": "name", + "description": "GSLB service type", + "name": "gslbservicetype", "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": "DNS domain name given for the global load balancer", - "name": "gslbdomainname", + "description": "Load balancing method used for the global load balancer", + "name": "gslblbmethod", "type": "string" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, - {}, { - "description": "GSLB service type", - "name": "gslbservicetype", + "description": "name of the global load balancer rule", + "name": "name", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "global load balancer rule ID", + "name": "id", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", + "description": "session persistence method used for the global load balancer", + "name": "gslbstickysessionmethodname", "type": "string" }, { "description": "List of load balancer rules that are part of GSLB rule", "name": "loadbalancerrule", "response": [ + { + "description": "the load balancer rule ID", + "name": "id", + "type": "string" + }, { "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", + "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", + "type": "string" + }, + { + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, { @@ -136162,38 +136897,38 @@ "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": "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": "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 domain associated with the tag", + "name": "domain", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -136202,43 +136937,18 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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" } ], "type": "list" }, - { - "description": "the public port", - "name": "publicport", - "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 id of the guest network the lb rule belongs to", - "name": "networkid", - "type": "string" - }, - { - "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", @@ -136255,23 +136965,23 @@ "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the public ip address", + "name": "publicip", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, { - "description": "the load balancer rule ID", - "name": "id", - "type": "string" + "description": "is rule for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { - "description": "the domain ID of the load balancer rule", - "name": "domainid", + "description": "the state of the rule", + "name": "state", "type": "string" }, { @@ -136280,18 +136990,23 @@ "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the load balancer algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the domain ID of the load balancer rule", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -136300,36 +137015,101 @@ "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 name of the zone the load balancer rule belongs to", - "name": "zonename", + "description": "the name of the load balancer", + "name": "name", "type": "string" } ], "type": "list" }, { - "description": "Load balancing method used for the global load balancer", - "name": "gslblbmethod", + "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", + "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", + "type": "string" + }, + { + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, + {} + ] + }, + { + "description": "Allow or disallow a user to use SAML SSO", + "isasync": false, + "name": "authorizeSamlSso", + "params": [ + { + "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": "User uuid", + "length": 255, + "name": "userid", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + }, + { + "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": "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": "session persistence method used for the global load balancer", - "name": "gslbstickysessionmethodname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -136363,21 +137143,11 @@ ], "related": "", "response": [ - { - "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 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 host ID of the host tag", @@ -136385,16 +137155,26 @@ "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the host tag", + "name": "name", + "type": "string" }, + {}, { "description": "the ID of the host tag", "name": "id", "type": "string" }, - {} + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "true if the host tag is implicit", + "name": "isimplicit", + "type": "boolean" + } ] }, { @@ -136403,25 +137183,25 @@ "name": "addGuestOs", "params": [ { - "description": "Optional name for Guest OS", + "description": "Unique display name for Guest OS", "length": 255, - "name": "name", - "required": false, + "name": "osdisplayname", + "required": true, "type": "string" }, { - "description": "Unique display name for Guest OS", + "description": "Optional name for Guest OS", "length": 255, - "name": "osdisplayname", - "required": true, + "name": "name", + "required": false, "type": "string" }, { - "description": "Map of (key/value pairs)", + "description": "whether this guest OS is available for end users", "length": 255, - "name": "details", + "name": "forDisplay", "required": false, - "type": "map" + "type": "boolean" }, { "description": "ID of Guest OS category", @@ -136432,37 +137212,47 @@ "type": "uuid" }, { - "description": "whether this guest OS is available for end users", + "description": "Map of (key/value pairs)", "length": 255, - "name": "forDisplay", + "name": "details", "required": false, - "type": "boolean" + "type": "map" } ], "related": "", "response": [ - {}, { - "description": "the name of the OS type", - "name": "name", + "description": "the name of the OS category", + "name": "oscategoryname", "type": "string" }, + {}, { - "description": "the ID of the OS category", - "name": "oscategoryid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the name/description of the OS type", - "name": "description", + "description": "the name of the OS type", + "name": "name", "type": "string" }, + { + "description": "is the guest OS user defined", + "name": "isuserdefined", + "type": "boolean" + }, {}, { "description": "is the guest OS visible for the users", "name": "fordisplay", "type": "boolean" }, + { + "description": "the name/description of the OS type", + "name": "description", + "type": "string" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -136474,18 +137264,8 @@ "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the OS category", + "name": "oscategoryid", "type": "string" } ], @@ -136497,31 +137277,31 @@ "name": "addAnnotation", "params": [ { - "description": "the id of the entity to annotate", + "description": "the annotation is visible for admins only", "length": 255, - "name": "entityid", + "name": "adminsonly", "required": false, - "type": "string" + "since": "4.16.0", + "type": "boolean" }, { - "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", + "description": "the annotation text", "length": 255, - "name": "entitytype", + "name": "annotation", "required": false, "type": "string" }, { - "description": "the annotation is visible for admins only", + "description": "the id of the entity to annotate", "length": 255, - "name": "adminsonly", + "name": "entityid", "required": false, - "since": "4.16.0", - "type": "boolean" + "type": "string" }, { - "description": "the annotation text", + "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, - "name": "annotation", + "name": "entitytype", "required": false, "type": "string" } @@ -136534,8 +137314,13 @@ "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 contents of the annotation", + "name": "annotation", "type": "string" }, { @@ -136544,28 +137329,24 @@ "type": "date" }, { - "description": "The username of the user that entered the annotation", - "name": "username", + "description": "the (uu)id of the annotation", + "name": "id", "type": "string" }, { - "description": "the removal timestamp for this annotation", - "name": "removed", - "type": "date" - }, - { - "description": "the contents of the annotation", - "name": "annotation", + "description": "the name of the entity to which this annotation pertains", + "name": "entityname", "type": "string" }, + {}, { - "description": "the (uu)id of the annotation", - "name": "id", + "description": "The (uu)id of the user that entered the annotation", + "name": "userid", "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" }, { @@ -136573,17 +137354,16 @@ "name": "entitytype", "type": "string" }, + {}, { - "description": "the name of the entity to which this annotation pertains", - "name": "entityname", - "type": "string" + "description": "the removal timestamp for this annotation", + "name": "removed", + "type": "date" }, - {}, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "The username of the user that entered the annotation", + "name": "username", + "type": "string" }, { "description": "True if the annotation is available for admins only", @@ -136593,6 +137373,42 @@ ], "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", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "The IdP Organization URL", + "name": "orgUrl", + "type": "string" + }, + { + "description": "The IdP Organization Name", + "name": "orgName", + "type": "string" + } + ] + }, { "description": "Creates new NS Vpx", "isasync": true, @@ -136607,19 +137423,19 @@ "type": "uuid" }, { - "description": "The network this ip address should be associated to.", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "networkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "The network this ip address should be associated to.", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "networkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "required": false, "type": "uuid" }, { @@ -136634,13 +137450,8 @@ "related": "addNetscalerLoadBalancer,registerNetscalerControlCenter", "response": [ { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", - "type": "boolean" - }, - { - "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" }, { @@ -136649,28 +137460,23 @@ "type": "boolean" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "type": "string" - }, - { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "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": "the physical network to which this netscaler 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": "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 id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, { @@ -136679,19 +137485,19 @@ "type": "boolean" }, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "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": "device capacity", + "name": "lbdevicecapacity", + "type": "long" }, - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { @@ -136700,13 +137506,18 @@ "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + { + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device name", - "name": "lbdevicename", + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", "type": "string" }, { @@ -136716,8 +137527,13 @@ }, {}, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "device name", + "name": "lbdevicename", + "type": "string" + }, + { + "description": "name of the provider", + "name": "provider", "type": "string" } ] @@ -136737,17 +137553,16 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "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", @@ -136758,14 +137573,19 @@ "name": "graceallowed", "type": "string" }, + { + "description": "the name of the volume", + "name": "name", + "type": "string" + }, { "description": "deduplication", "name": "deduplication", "type": "string" }, { - "description": "the name of the volume", - "name": "name", + "description": "synchronization", + "name": "sync", "type": "string" }, { @@ -136774,11 +137594,7 @@ "type": "string" }, {}, - { - "description": "synchronization", - "name": "sync", - "type": "string" - } + {} ] }, { @@ -136786,6 +137602,21 @@ "isasync": true, "name": "addBaremetalPxeKickStartServer", "params": [ + { + "description": "Tftp root directory of PXE server", + "length": 255, + "name": "tftpdir", + "required": true, + "type": "string" + }, + { + "description": "Pod Id", + "length": 255, + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, { "description": "URL of the external pxe device", "length": 255, @@ -136794,9 +137625,9 @@ "type": "string" }, { - "description": "type of pxe device", + "description": "Credentials to reach external pxe device", "length": 255, - "name": "pxeservertype", + "name": "password", "required": true, "type": "string" }, @@ -136808,14 +137639,6 @@ "required": true, "type": "uuid" }, - { - "description": "Pod Id", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": false, - "type": "uuid" - }, { "description": "Credentials to reach external pxe device", "length": 255, @@ -136824,16 +137647,9 @@ "type": "string" }, { - "description": "Tftp root directory of PXE server", - "length": 255, - "name": "tftpdir", - "required": true, - "type": "string" - }, - { - "description": "Credentials to reach external pxe device", + "description": "type of pxe device", "length": 255, - "name": "password", + "name": "pxeservertype", "required": true, "type": "string" } @@ -136847,8 +137663,8 @@ }, {}, { - "description": "device id of ", - "name": "id", + "description": "Tftp root directory of PXE server", + "name": "tftpdir", "type": "string" }, { @@ -136856,11 +137672,6 @@ "name": "physicalnetworkid", "type": "string" }, - { - "description": "Tftp root directory of PXE server", - "name": "tftpdir", - "type": "string" - }, { "description": "name of the provider", "name": "provider", @@ -136876,6 +137687,11 @@ "name": "jobid", "type": "string" }, + { + "description": "device id of ", + "name": "id", + "type": "string" + }, {} ] }, @@ -136885,18 +137701,12 @@ "name": "listNiciraNvpDevices", "params": [ { - "description": "", - "length": 255, - "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": "", @@ -136906,74 +137716,80 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "nicira nvp device ID", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "nvpdeviceid", + "related": "addNiciraNvpDevice,listNiciraNvpDevices", "required": false, "type": "uuid" }, { - "description": "nicira nvp device ID", + "description": "", "length": 255, - "name": "nvpdeviceid", - "related": "addNiciraNvpDevice,listNiciraNvpDevices", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" } ], "related": "addNiciraNvpDevice", "response": [ { - "description": "this L2 gateway service Uuid", - "name": "l2gatewayserviceuuid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device name", + "name": "niciradevicename", "type": "string" }, + {}, { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", + "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 transport zone Uuid", - "name": "transportzoneuuid", + "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": "device id of the Nicire Nvp", - "name": "nvpdeviceid", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "this L2 gateway service Uuid", + "name": "l2gatewayserviceuuid", "type": "string" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "device id of the Nicire Nvp", + "name": "nvpdeviceid", "type": "string" }, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the transport zone Uuid", + "name": "transportzoneuuid", "type": "string" } ] @@ -136984,34 +137800,34 @@ "name": "listAlerts", "params": [ { - "description": "List by keyword", + "description": "the ID of the alert", "length": 255, - "name": "keyword", + "name": "id", + "related": "listAlerts", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list by alert name", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "since": "4.3", - "type": "string" + "type": "integer" }, { - "description": "", + "description": "list by alert type", "length": 255, - "name": "pagesize", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the alert", + "description": "list by alert name", "length": 255, - "name": "id", - "related": "listAlerts", + "name": "name", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { "description": "", @@ -137021,9 +137837,9 @@ "type": "integer" }, { - "description": "list by alert type", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" } @@ -137035,9 +137851,15 @@ "name": "jobid", "type": "string" }, + {}, { - "description": "description of the alert", - "name": "description", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the alert", + "name": "name", "type": "string" }, { @@ -137045,28 +137867,22 @@ "name": "sent", "type": "date" }, - { - "description": "the name of the alert", - "name": "name", - "type": "string" - }, - {}, { "description": "the id of the alert", "name": "id", "type": "string" }, - {}, - { - "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": "description of the alert", + "name": "description", + "type": "string" + }, + {} ] }, { @@ -137075,17 +137891,17 @@ "name": "deployVirtualMachine", "params": [ { - "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "description": "availability zone for the virtual machine", "length": 255, - "name": "bootintosetup", - "required": false, - "since": "4.15.0.0", - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "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": "the ip address for default vm's network", "length": 255, - "name": "customid", + "name": "ipaddress", "required": false, "type": "string" }, @@ -137099,81 +137915,75 @@ "type": "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": "rootdisksize", - "required": false, - "since": "4.4", - "type": "long" - }, - { - "description": "host name for the virtual machine", + "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": "name", + "name": "hypervisor", "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", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", "length": 255, - "name": "dhcpoptionsnetworklist", + "name": "externaldetails", "required": false, + "since": "4.21.0", "type": "map" }, { - "description": "Number of days instance is leased for.", + "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": "leaseduration", + "name": "overridediskofferingid", + "related": "", "required": false, - "since": "4.21.0", - "type": "integer" + "since": "4.17", + "type": "uuid" }, { - "description": "the ipv6 address for default vm's network", + "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": "ip6address", + "name": "affinitygroupids", + "related": "", "required": false, - "type": "string" + "type": "list" }, { - "description": "", + "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", "length": 255, - "name": "volumeid", - "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "name": "size", "required": false, - "since": "4.21", - "type": "uuid" + "type": "long" }, { - "description": "Lease expiry action, valid values are STOP and DESTROY", + "description": "destination Host ID to deploy the VM to - parameter available for root admin only", "length": 255, - "name": "leaseexpiryaction", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, - "since": "4.21.0", - "type": "string" + "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": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", "length": 255, - "name": "overridediskofferingid", - "related": "", + "name": "networkids", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "since": "4.17", - "type": "uuid" + "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": "an optional field, whether to the display the vm to the end user or not.", + "length": 255, + "name": "displayvm", "required": false, - "type": "string" + "since": "4.2", + "type": "boolean" }, { - "description": "Deploy vm for the project", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "snapshotid", + "related": "copySnapshot,listSnapshots", "required": false, + "since": "4.21", "type": "uuid" }, { @@ -137184,40 +137994,27 @@ "type": "boolean" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "list of network ids used by virtual machine. Can't be specified with ipToNetworkList parameter", + "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": "networkids", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "securitygroupnames", + "related": "", "required": false, "type": "list" }, { - "description": "an optional group for the virtual machine", - "length": 255, - "name": "group", - "required": false, - "type": "string" - }, - { - "description": "an optional user generated name for the virtual machine", - "length": 255, - "name": "displayname", + "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 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 service offering for the virtual machine", "length": 255, - "name": "diskofferingid", - "related": "", - "required": false, + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": true, "type": "uuid" }, { @@ -137228,112 +138025,117 @@ "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": "", + "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": "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 field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "keyboard", + "name": "customid", "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": "The password of the virtual machine. If null, a random password will be generated for the VM.", "length": 255, - "name": "securitygroupids", - "related": "", + "name": "password", "required": false, - "type": "list" + "since": "4.19.0.0", + "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].server.type=typevalue", + "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": "externaldetails", + "name": "dhcpoptionsnetworklist", "required": false, - "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": "an optional group for the virtual machine", "length": 255, - "name": "affinitygroupids", - "related": "", + "name": "group", "required": false, - "type": "list" + "type": "string" }, { - "description": "the arbitrary size for the DATADISK volume. Mutually exclusive with diskOfferingId", + "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": "size", + "name": "datadiskofferinglist", "required": false, - "type": "long" + "since": "4.11", + "type": "map" }, { - "description": "names of the ssh key pairs used to login to the virtual machine", + "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": "keypairs", + "name": "bootmode", "required": false, - "since": "4.17", - "type": "list" + "since": "4.14.0.0", + "type": "string" }, { - "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", + "description": "true if start vm after creating; defaulted to true if not specified", "length": 255, - "name": "datadisksdetails", + "name": "startvm", "required": false, - "since": "4.21.0", - "type": "map" + "type": "boolean" }, { - "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "description": "host name for the virtual machine", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "name", "required": false, - "since": "4.13", - "type": "uuid" + "type": "string" }, { - "description": "an optional field, whether to the display the vm to the end user or not.", + "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": "displayvm", + "name": "rootdisksize", "required": false, - "since": "4.2", + "since": "4.4", + "type": "long" + }, + { + "description": "Enable packed virtqueues or not.", + "length": 255, + "name": "nicpackedvirtqueuesenabled", + "required": false, + "since": "4.18", "type": "boolean" }, { - "description": "the mac address for default vm's network", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "macaddress", + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "Number of days instance is leased for.", "length": 255, - "name": "iptonetworklist", + "name": "leaseduration", "required": false, - "type": "map" + "since": "4.21.0", + "type": "integer" }, { - "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": "name of the ssh key pair used to login to the virtual machine", "length": 255, - "name": "hypervisor", + "name": "keypair", "required": false, "type": "string" }, { - "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", + "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": "details", + "name": "boottype", "required": false, - "since": "4.3", - "type": "map" + "since": "4.14.0.0", + "type": "string" }, { "description": "destination Pod ID to deploy the VM to - parameter available for root admin only", @@ -137345,36 +138147,43 @@ "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": "The number of queues for multiqueue NICs.", "length": 255, - "name": "affinitygroupnames", - "related": "", + "name": "nicmultiqueuenumber", "required": false, - "type": "list" + "since": "4.18", + "type": "integer" }, { - "description": "name of the ssh key pair used to login to the virtual machine", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, { - "description": "", + "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": "snapshotid", - "related": "copySnapshot,listSnapshots", + "name": "keyboard", "required": false, - "since": "4.21", + "type": "string" + }, + { + "description": "destination Cluster ID to deploy the VM to - parameter available for root admin only", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": false, + "since": "4.13", "type": "uuid" }, { - "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": "used to specify the vApp properties.", "length": 255, - "name": "bootmode", + "name": "properties", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.15", + "type": "map" }, { "description": "true if virtual machine needs to be dynamically scalable", @@ -137385,37 +138194,21 @@ "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.", + "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": "domainid", - "related": "listDomains", + "name": "securitygroupids", + "related": "", "required": false, - "type": "uuid" + "type": "list" }, { - "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": "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": "nicnetworklist", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.15", - "type": "map" - }, - { - "description": "availability zone for the virtual machine", - "length": 255, - "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, @@ -137425,394 +138218,277 @@ "type": "map" }, { - "description": "the ID of the service offering for the virtual machine", + "description": "Deploy vm for the project", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", - "required": true, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" }, { - "description": "The number of queues for multiqueue NICs.", + "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": "nicmultiqueuenumber", + "name": "affinitygroupnames", + "related": "", "required": false, - "since": "4.18", - "type": "integer" + "type": "list" }, { - "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": "names of the ssh key pairs used to login to the virtual machine", "length": 255, - "name": "boottype", + "name": "keypairs", "required": false, - "since": "4.14.0.0", - "type": "string" + "since": "4.17", + "type": "list" }, { - "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "description": "Lease expiry action, valid values are STOP and DESTROY", "length": 255, - "name": "deploymentplanner", + "name": "leaseexpiryaction", "required": false, - "since": "4.4", + "since": "4.21.0", "type": "string" }, { - "description": "the ip address for default vm's network", + "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": "ipaddress", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Enable packed virtqueues or not.", + "description": "if true the image tags (if any) will be copied to the VM, default value is false", "length": 255, - "name": "nicpackedvirtqueuesenabled", + "name": "copyimagetags", "required": false, - "since": "4.18", + "since": "4.13", "type": "boolean" }, { - "description": "the ID of the template for the virtual machine", + "description": "the mac address for default vm's network", "length": 255, - "name": "templateid", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "macaddress", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "used to specify the vApp properties.", + "description": "used to specify the custom parameters. 'extraconfig' is not allowed to be passed in details", "length": 255, - "name": "properties", + "name": "details", "required": false, - "since": "4.15", + "since": "4.3", "type": "map" }, { - "description": "if true the image tags (if any) will be copied to the VM, default value is false", - "length": 255, - "name": "copyimagetags", - "required": false, - "since": "4.13", - "type": "boolean" - }, - { - "description": "The password of the virtual machine. If null, a random password will be generated for the VM.", + "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": "password", + "name": "datadisksdetails", "required": false, - "since": "4.19.0.0", - "type": "string" + "since": "4.21.0", + "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": "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": "datadiskofferinglist", + "name": "iptonetworklist", "required": false, - "since": "4.11", "type": "map" }, { - "description": "destination Host ID to deploy the VM to - parameter available for root admin only", + "description": "", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "volumeid", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, + "since": "4.21", "type": "uuid" }, { - "description": "true if start vm after creating; defaulted to true if not specified", + "description": "the ipv6 address for default vm's network", "length": 255, - "name": "startvm", + "name": "ip6address", "required": false, - "type": "boolean" - } - ], - "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": "OS type id of the vm", - "name": "ostypeid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" - }, - { - "description": "CPU arch of the VM", - "name": "arch", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "an optional user generated name for the virtual machine", + "length": 255, + "name": "displayname", + "required": false, "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "description": "Boot into hardware setup or not (ignored if startVm = false, only valid for vmware)", + "length": 255, + "name": "bootintosetup", + "required": false, + "since": "4.15.0.0", "type": "boolean" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "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", + "length": 255, + "name": "nicnetworklist", + "required": false, + "since": "4.15", + "type": "map" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Deployment planner to use for vm allocation. Available to ROOT admin only", + "length": 255, + "name": "deploymentplanner", + "required": false, + "since": "4.4", "type": "string" - }, + } + ], + "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,createVMFromBackup,importVm", + "response": [ { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "device ID of the root volume", - "name": "rootdeviceid", + "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 group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" - }, - { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", "type": "long" }, { - "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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "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": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" + "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", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", - "type": "string" + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { "description": "the format of the template for the virtual machine", "name": "templateformat", "type": "string" }, - {}, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" - }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "ssh key-pairs", + "name": "keypairs", "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": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "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", + "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", + "description": "the name of userdata used for the VM", + "name": "userdataname", "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 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", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "description": "the pool type of the virtual machine", + "name": "pooltype", "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", + "description": "Guest vm Boot Type", + "name": "boottype", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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 maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" - }, - { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -137820,99 +138496,42 @@ "name": "securitygroup", "response": [ { - "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": "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": "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 name where tag belongs to", - "name": "project", - "type": "string" + "description": "the ending IP of the security group rule ", + "name": "endport", + "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 starting IP of the security group rule", + "name": "startport", + "type": "integer" }, { - "description": "the account associated with the tag", + "description": "account owning the security group rule", "name": "account", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", - "name": "projectid", - "type": "string" - }, - { - "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 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", + "description": "the protocol of the security group rule", + "name": "protocol", "type": "string" }, { @@ -137920,152 +138539,259 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", "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": "id of the resource", - "name": "resourceid", + "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 domain associated with the tag", - "name": "domain", + "description": "the project id the tag belongs to", + "name": "projectid", "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": "tag key name", + "name": "key", "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "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", "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" + } + ], + "type": "set" + }, + { + "description": "the name of the security group", + "name": "name", + "type": "string" + }, + { + "description": "the project id of the group", + "name": "projectid", + "type": "string" + }, + { + "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 domain name of the security group", + "name": "domain", + "type": "string" + }, + { + "description": "the description of the security group", + "name": "description", + "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": "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": "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "account owning the security group rule", + "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 id the tag belongs to", + "name": "projectid", + "type": "string" }, { - "description": "security group name", - "name": "securitygroupname", + "description": "tag value", + "name": "value", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", "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 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", + "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": "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 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 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", - "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": "tag value", + "name": "value", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -138079,8 +138805,13 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -138089,8 +138820,8 @@ "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" }, { @@ -138100,386 +138831,271 @@ } ], "type": "set" - }, - { - "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 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 id of the security group rule", - "name": "ruleid", - "type": "string" - }, - { - "description": "security group name", - "name": "securitygroupname", - "type": "string" - }, - { - "description": "the protocol of the security group rule", - "name": "protocol", - "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": "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 list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" } ], "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 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": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "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": "OS name of the vm", + "name": "osdisplayname", + "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "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 account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the maximum X resolution", + "name": "maxresolutionx", "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 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": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "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 outgoing network traffic on the host in KiB", - "name": "networkkbswrite", + "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 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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "type": "string" }, { - "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "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", + "description": "the number of vCPUs this virtual machine is using", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the memory used by the VM in KiB", + "name": "memorykbs", "type": "long" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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 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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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 memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "customer associated with the tag", - "name": "customer", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the netmask of the nic", + "name": "netmask", "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 value", - "name": "value", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "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": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "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": "the isolation uri of the nic", + "name": "isolationuri", "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" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "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": "the list of nics associated with vm", - "name": "nic", - "response": [ + }, { - "description": "the ID of the nic", - "name": "id", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "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": "the gateway of IPv6 network", - "name": "ip6gateway", + "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", + "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 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": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { "description": "the cidr of IPv6 network", @@ -138487,202 +139103,402 @@ "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": "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 vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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": "tag key name", + "name": "key", + "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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 project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "resource type", + "name": "resourcetype", + "type": "string" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "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", + "type": "string" + } + ], + "type": "set" + }, + { + "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", + "type": "string" + }, + { + "description": "the ID of the host for the virtual machine", + "name": "hostid", + "type": "string" + }, + { + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" + }, + { + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "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 ID of the affinity group", + "name": "id", "type": "string" } ], "type": "set" }, + { + "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": "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": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "type": "string" + }, + { + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, {}, + { + "description": "the VM's primary IP address", + "name": "ipaddress", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", + "type": "string" + }, { "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": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "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 outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "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", + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" + }, + { + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "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": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "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": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", "type": "string" }, + {}, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the state of the virtual machine", + "name": "state", "type": "string" } ] @@ -138693,107 +139509,96 @@ "name": "listVolumes", "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": "the cluster id the disk volume belongs to", + "description": "List by keyword", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "keyword", "required": false, - "type": "uuid" + "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 display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "isrecursive", + "name": "displayvolume", "required": false, + "since": "4.4", "type": "boolean" }, { - "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 resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "account", "required": false, - "since": "4.19.1", - "type": "uuid" + "type": "string" }, { - "description": "list volumes on specified host", + "description": "the ID of the availability zone", "length": 255, - "name": "hostid", - "related": "declareHostAsDegraded,reconnectHost", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the virtual machine", "length": 255, - "name": "pagesize", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "projectid", - "related": "", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the availability zone", + "description": "list volumes on specified host", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "hostid", + "related": "declareHostAsDegraded,reconnectHost", "required": false, "type": "uuid" }, { - "description": "list only volumes that are encrypted", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "isencrypted", + "name": "tags", "required": false, - "since": "4.19.1", - "type": "boolean" + "type": "map" }, { - "description": "the ID of the virtual machine", + "description": "the ID of the storage pool, available to ROOT admin only", "length": 255, - "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", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "uuid" + "since": "4.3", + "type": "string" }, { - "description": "list volumes by disk offering", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.4", "type": "uuid" }, { - "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", + "description": "the name of the disk volume", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, { - "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" }, { "description": "", @@ -138803,43 +139608,44 @@ "type": "integer" }, { - "description": "the name of the disk volume", + "description": "list volumes by disk offering", "length": 255, - "name": "name", + "name": "diskofferingid", + "related": "", "required": false, - "type": "string" + "since": "4.4", + "type": "uuid" }, { - "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 pod id the disk volume belongs to", + "description": "the ID of the disk volume", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "id", + "related": "createVolume,listVolumes,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": false, "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "displayvolume", + "name": "projectid", + "related": "", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the storage pool, available to ROOT admin only", + "description": "the cluster id the disk volume belongs to", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.3", - "type": "string" + "type": "uuid" }, { "description": "the type of disk volume", @@ -138849,152 +139655,142 @@ "type": "string" }, { - "description": "the ID of the disk volume", + "description": "the IDs of the volumes, mutually exclusive with id", "length": 255, - "name": "id", + "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 only resources belonging to the domain specified", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "list only volumes that are encrypted", "length": 255, - "name": "account", + "name": "isencrypted", "required": false, - "type": "string" + "since": "4.19.1", + "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 resources by tags (key/value pairs)", + "description": "the pod id the disk volume belongs to", "length": 255, - "name": "tags", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "makes the API's response contains only the resource count", + "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": "retrieveonlyresourcecount", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "type": "boolean" + "since": "4.19.1", + "type": "uuid" }, { - "description": "list system VMs; only ROOT admin is eligible to pass this parameter", + "description": "state of the volume. Possible values are: Ready, Allocated, Destroy, Expunging, Expunged.", "length": 255, - "name": "listsystemvms", + "name": "state", "required": false, - "since": "4.18", - "type": "boolean" + "type": "string" } ], "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": "pod id of the volume", - "name": "podid", - "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": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", "type": "string" }, { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", "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 read (IO) of disk on the vm", - "name": "diskioread", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", "type": "long" }, { - "description": "ID of the disk volume", - "name": "id", + "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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" - }, - { - "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": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "shared or local storage", + "name": "storagetype", "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": "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", @@ -139002,93 +139798,79 @@ "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" - }, - { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "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 bytes allocated", - "name": "virtualsize", + "description": "the read (IO) of disk on the vm", + "name": "diskioread", "type": "long" }, { - "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": "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" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "provisioning type used to create volumes.", - "name": "provisioningtype", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "ID of the disk volume", + "name": "id", "type": "string" }, { @@ -139097,25 +139879,14 @@ "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "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.", @@ -139123,9 +139894,9 @@ "type": "string" }, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { "description": "IO requests read rate of the disk volume per the disk offering", @@ -139133,94 +139904,38 @@ "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" - }, - { - "description": "min iops of the disk volume", - "name": "miniops", - "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": "id of the primary storage hosting the disk volume; returned to admin user only", - "name": "storageid", - "type": "string" - }, - { - "description": "shared or local storage", - "name": "storagetype", + "description": "name of the disk offering", + "name": "diskofferingname", "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": "pod name of the volume", - "name": "podname", + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "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": "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", - "name": "storage", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", - "type": "string" - }, - { - "description": "the disk utilization", - "name": "utilization", - "type": "string" - }, - { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", - "type": "string" + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", - "type": "string" + "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", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { @@ -139228,23 +139943,23 @@ "name": "tags", "response": [ { - "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": "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": "the domain associated with the tag", - "name": "domain", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -139253,13 +139968,13 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -139268,57 +139983,158 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "description": "details for the volume repair result, they may vary for different hypervisors", - "name": "volumerepairresult", - "type": "map" + "description": "name of the service offering for root disk", + "name": "serviceofferingname", + "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", + "description": "the path of the volume", + "name": "path", + "type": "string" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", "type": "boolean" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "type": "long" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, + { + "description": "pod name of the volume", + "name": "podname", "type": "string" }, + {}, { - "description": "size of the disk volume", - "name": "size", + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" + }, + { + "description": "the date the volume was attached to a VM instance", + "name": "attached", + "type": "date" + }, + { + "description": "min iops of the disk volume", + "name": "miniops", "type": "long" }, + { + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" + }, { "description": "the state of the disk volume", "name": "state", "type": "string" + }, + { + "description": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" + }, + { + "description": "the status of the volume", + "name": "status", + "type": "string" + }, + { + "description": "the disk utilization", + "name": "utilization", + "type": "string" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "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": "name of the availability zone", + "name": "zonename", + "type": "string" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "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": "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": "the bytes allocated", + "name": "virtualsize", + "type": "long" + }, + { + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" } ] }, @@ -139338,9 +140154,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" }, { "description": "true if operation is executed successfully", @@ -139352,13 +140168,13 @@ "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" + } ] }, { @@ -139367,17 +140183,9 @@ "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", + "description": "Time to wait when receiving a response from the health check (2sec - 60 sec)", "length": 255, - "name": "unhealthythreshold", + "name": "responsetimeout", "required": false, "type": "integer" }, @@ -139389,26 +140197,26 @@ "type": "integer" }, { - "description": "the ID of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" }, { - "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" }, { - "description": "the description of the load balancer health check policy", + "description": "Number of consecutive health check failures before declaring an instance unhealthy", "length": 255, - "name": "description", + "name": "unhealthythreshold", "required": false, - "type": "string" + "type": "integer" }, { "description": "Number of consecutive health check success before declaring an instance healthy", @@ -139418,50 +140226,38 @@ "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" } ], "related": "", "response": [ - { - "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", - "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" }, { - "description": "the domain ID of the HealthCheck policy", - "name": "domainid", + "description": "the LB rule ID", + "name": "lbruleid", "type": "string" }, { @@ -139469,24 +140265,29 @@ "name": "healthcheckpolicy", "response": [ { - "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", + "description": "Number of consecutive health check success before declaring an instance healthy", + "name": "healthcheckthresshold", "type": "int" }, { - "description": "the LB HealthCheck policy ID", - "name": "id", + "description": "the pingpath of the healthcheck policy", + "name": "pingpath", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "Time to wait when receiving a response from the health check", + "name": "responsetime", + "type": "int" + }, + { + "description": "Amount of time between health checks", + "name": "healthcheckinterval", + "type": "int" }, { "description": "is policy for display to the regular user", @@ -139499,14 +140300,9 @@ "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", - "type": "int" + "description": "the LB HealthCheck policy ID", + "name": "id", + "type": "string" }, { "description": "the description of the healthcheck policy", @@ -139515,6 +140311,26 @@ } ], "type": "list" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the account of the HealthCheck policy", + "name": "account", + "type": "string" + }, + { + "description": "the domain ID of the HealthCheck policy", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain of the HealthCheck policy", + "name": "domain", + "type": "string" } ], "since": "4.2.0" @@ -139525,18 +140341,18 @@ "name": "changeSharedFileSystemServiceOffering", "params": [ { - "description": "the offering to use for the shared filesystem instance", + "description": "the ID of the shared filesystem", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", "required": true, "type": "uuid" }, { - "description": "the ID of the shared filesystem", + "description": "the offering to use for the shared filesystem instance", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering,changeSharedFileSystemServiceOffering", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" } @@ -139544,27 +140360,32 @@ "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "response": [ { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", "type": "string" }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -139573,18 +140394,18 @@ "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -139593,47 +140414,48 @@ "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": "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": "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "description": "Name of the availability zone", - "name": "zonename", - "type": "string" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, + {}, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "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 shared filesystem", @@ -139645,93 +140467,83 @@ "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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 traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "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 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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the ID of the corresponding network", + "name": "networkid", "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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "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", + "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 ID of the nic", + "name": "id", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", - "type": "string" + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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", + "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", - "type": "list" - }, - { - "description": "the ID of the nic", - "name": "id", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { @@ -139740,33 +140552,33 @@ "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the isolated private VLAN if available", + "name": "isolatedpvlan", "type": "integer" }, { - "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": "the netmask of the nic", - "name": "netmask", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "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": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -139774,47 +140586,42 @@ "name": "adaptertype", "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 gateway of the nic", "name": "gateway", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "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 isolation uri of the nic", + "name": "isolationuri", "type": "string" } ], "type": "list" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" - }, - { - "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", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { @@ -139823,56 +140630,55 @@ "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", - "type": "string" + "description": "the shared filesystem's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, + {}, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "Name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", + "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", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "disk offering ID for the shared filesystem", + "name": "diskofferingid", "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": "name of the storage fs data volume", @@ -139880,103 +140686,113 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the shared filesystem's disk read in KiB", - "name": "diskkbsread", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", "type": "long" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "the shared filesystem provider", + "name": "provider", "type": "string" }, { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "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 pool hosting the data volume", + "name": "storage", + "type": "string" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", - "type": "long" + "description": "path to mount the shared filesystem", + "name": "path", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", + "type": "string" }, { - "description": "the filesystem format", - "name": "filesystem", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "ID of the shared filesystem", + "name": "id", "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": "the read (IO) of disk on the shared filesystem", - "name": "diskioread", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "path to mount the shared filesystem", - "name": "path", - "type": "string" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "the domain associated with the shared filesystem", + "name": "domain", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "vmstate", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" } ], @@ -139990,68 +140806,57 @@ { "description": "Locks user by user ID.", "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers,lockUser", - "required": true, - "type": "uuid" - } - ], - "related": "disableUser,getUser,listUsers", - "response": [ - { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" - }, - {}, - { - "description": "the name of the role", - "name": "rolename", - "type": "string" - }, + "name": "id", + "related": "disableUser,getUser,listUsers,lockUser", + "required": true, + "type": "uuid" + } + ], + "related": "disableUser,getUser,listUsers", + "response": [ { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, - { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" - }, { "description": "the user lastname", "name": "lastname", "type": "string" }, { - "description": "the user name", - "name": "username", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", - "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": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "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" }, { @@ -140060,60 +140865,60 @@ "type": "boolean" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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 api key of the user", + "name": "apikey", + "type": "string" }, - {}, { - "description": "the user ID", - "name": "id", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the secret key of the user", + "name": "secretkey", "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the type of the role", + "name": "roletype", "type": "string" }, + {}, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the name of the role", + "name": "rolename", "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 enabled", + "name": "is2faenabled", "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 user email address", - "name": "email", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { "description": "whether api key access is Enabled, Disabled or set to Inherit (it inherits the value from the parent)", @@ -140121,19 +140926,30 @@ "type": "apikeyaccess" }, { - "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" }, { - "description": "true if user 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 account type of the user", - "name": "accounttype", - "type": "integer" + "description": "the user email address", + "name": "email", + "type": "string" + }, + {}, + { + "description": "the user state", + "name": "state", + "type": "string" + }, + { + "description": "the account ID of the user", + "name": "accountid", + "type": "string" } ] }, @@ -140144,27 +140960,27 @@ "params": [], "related": "", "response": [ + {}, { - "description": "the Cloudian connector enabled state", - "name": "enabled", - "type": "boolean" + "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" }, - {}, - {}, { "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 Cloudian connector enabled state", + "name": "enabled", + "type": "boolean" } ], "since": "4.11.0" @@ -140175,43 +140991,33 @@ "name": "createNetwork", "params": [ { - "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": "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": "domainid", - "related": "listDomains", + "name": "subdomainaccess", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the beginning IP address in the network IP range", + "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, - "name": "startip", + "name": "ip6cidr", "required": false, "type": "string" }, { - "description": "the zone ID for the network", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, - "type": "uuid" - }, - { - "description": "MTU to be configured on the network VR's public facing interfaces", + "description": "Account that will own the network. Account should be under the selected domain", "length": 255, - "name": "publicmtu", + "name": "account", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "string" }, { - "description": "IPV4 address to be assigned to a router in a shared network", + "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": "routerip", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.16", - "type": "string" + "type": "uuid" }, { "description": "the VPC network belongs to", @@ -140222,295 +141028,396 @@ "type": "uuid" }, { - "description": "the network offering ID", + "description": "Tungsten-Fabric virtual router the network belongs to", "length": 255, - "name": "networkofferingid", - "related": "listNetworkOfferings", - "required": true, - "type": "uuid" + "name": "tungstenvirtualrouteruuid", + "required": false, + "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", + "description": "the name of the network", "length": 255, - "name": "displaynetwork", - "required": false, - "type": "boolean" + "name": "name", + "required": true, + "type": "string" }, { - "description": "network domain", + "description": "the isolated private VLAN type for this network", "length": 255, - "name": "networkdomain", + "name": "isolatedpvlantype", "required": false, "type": "string" }, { - "description": "the isolated private VLAN for this network", + "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "isolatedpvlan", + "name": "gateway", "required": false, "type": "string" }, { - "description": "the first IPv4 DNS for the network", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "dns1", + "name": "startipv6", "required": false, - "since": "4.18.0", "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": "when true ip address usage for the network will not be exported by the listUsageRecords API", "length": 255, - "name": "subdomainaccess", + "name": "hideipaddressusage", "required": false, "type": "boolean" }, { - "description": "the CIDR of IPv6 network, must be at least /64", + "description": "the zone ID for the network", "length": 255, - "name": "ip6cidr", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "the second IPv4 DNS for the network", + "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", "length": 255, - "name": "dns2", + "name": "netmask", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "the gateway of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "The network this network is associated to. only available if create a Shared network", "length": 255, - "name": "gateway", + "name": "associatednetworkid", + "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "since": "4.17.0", + "type": "uuid" }, { - "description": "the first IPv6 DNS for the network", + "description": "the first IPv4 DNS for the network", "length": 255, - "name": "ip6dns1", + "name": "dns1", "required": false, "since": "4.18.0", "type": "string" }, { - "description": "the netmask of the network. Required for shared networks and isolated networks when it belongs to VPC", + "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", "length": 255, - "name": "netmask", + "name": "cidrsize", "required": false, - "type": "string" + "since": "4.20.0", + "type": "integer" }, { - "description": "Network ACL ID associated for the network", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "aclid", - "related": "createNetworkACLList", + "name": "endipv6", "required": false, - "type": "uuid" + "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": "IPV6 address to be assigned to a router in a shared network", "length": 255, - "name": "acltype", + "name": "routeripv6", "required": false, + "since": "4.16", "type": "string" }, { - "description": "the display text of the network", + "description": "an optional field, whether to the display the network to the end user or not.", "length": 255, - "name": "displaytext", + "name": "displaynetwork", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "Tungsten-Fabric virtual router the network belongs to", + "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": "tungstenvirtualrouteruuid", + "name": "sourcenatipaddress", "required": false, + "since": "4.19", "type": "string" }, { - "description": "the AS Number of the network", + "description": "MTU to be configured on the network VR's private interface(s)", "length": 255, - "name": "asnumber", + "name": "privatemtu", "required": false, - "since": "4.20.0", - "type": "long" + "since": "4.18.0", + "type": "integer" }, { - "description": "the second IPv6 DNS for the 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": "ip6dns2", + "name": "acltype", "required": false, - "since": "4.18.0", "type": "string" }, { - "description": "ID of the network in an external system.", + "description": "the ID or VID of the network", "length": 255, - "name": "externalid", + "name": "vlan", "required": false, "type": "string" }, { - "description": "The network this network is associated to. only available if create a Shared network", + "description": "the isolated private VLAN for this network", "length": 255, - "name": "associatednetworkid", - "related": "createNetwork,createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "isolatedpvlan", "required": false, - "since": "4.17.0", - "type": "uuid" + "type": "string" }, { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "ID of the network in an external system.", "length": 255, - "name": "endipv6", + "name": "externalid", "required": false, "type": "string" }, { - "description": "the CIDR size of IPv4 network. For regular users, this is required for isolated networks with ROUTED mode.", + "description": "the gateway of the IPv6 network. Required for Shared networks", "length": 255, - "name": "cidrsize", + "name": "ip6gateway", "required": false, - "since": "4.20.0", - "type": "integer" + "type": "string" }, { - "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 beginning IPv6 address in the IPv6 network range", + "description": "IPV4 address to be assigned to a router in a shared network", "length": 255, - "name": "startipv6", + "name": "routerip", "required": false, + "since": "4.16", "type": "string" }, { - "description": "an optional project for the network", + "description": "network domain", "length": 255, - "name": "projectid", - "related": "", + "name": "networkdomain", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the isolated private VLAN type for this network", + "description": "Ids of the Bgp Peer for the network", "length": 255, - "name": "isolatedpvlantype", + "name": "bgppeerids", + "related": "", "required": false, - "type": "string" + "since": "4.20.0", + "type": "list" }, { - "description": "Account that will own the network. Account should be under the selected domain", + "description": "the beginning IP address in the network IP range", "length": 255, - "name": "account", + "name": "startip", "required": false, "type": "string" }, { - "description": "the name of the network", + "description": "MTU to be configured on the network VR's public facing interfaces", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "publicmtu", + "required": false, + "since": "4.18.0", + "type": "integer" }, { - "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", + "description": "the first IPv6 DNS for the network", "length": 255, - "name": "endip", + "name": "ip6dns1", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "when true ip address usage for the network will not be exported by the listUsageRecords API", + "description": "the second IPv6 DNS for the network", "length": 255, - "name": "hideipaddressusage", + "name": "ip6dns2", "required": false, - "type": "boolean" + "since": "4.18.0", + "type": "string" }, { - "description": "the physical network ID the network belongs to", + "description": "the ending IP address in the network IP range. If not specified, will be defaulted to startIP", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "endip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID or VID of the network", + "description": "the second IPv4 DNS for the network", "length": 255, - "name": "vlan", + "name": "dns2", "required": false, + "since": "4.18.0", "type": "string" }, { - "description": "Ids of the Bgp Peer for the network", + "description": "the AS Number of the network", "length": 255, - "name": "bgppeerids", - "related": "", + "name": "asnumber", "required": false, "since": "4.20.0", - "type": "list" + "type": "long" }, { - "description": "MTU to be configured on the network VR's private interface(s)", + "description": "when true bypasses VLAN id/range overlap check during network creation for shared and L2 networks", "length": 255, - "name": "privatemtu", + "name": "bypassvlanoverlapcheck", "required": false, - "since": "4.18.0", - "type": "integer" + "type": "boolean" }, { - "description": "the gateway of the IPv6 network. Required for Shared networks", + "description": "an optional project for the network", "length": 255, - "name": "ip6gateway", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "IPV6 address to be assigned to a router in a shared network", + "description": "Network ACL ID associated for the network", "length": 255, - "name": "routeripv6", + "name": "aclid", + "related": "createNetworkACLList", "required": false, - "since": "4.16", - "type": "string" + "type": "uuid" }, { - "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 network offering ID", "length": 255, - "name": "sourcenatipaddress", + "name": "networkofferingid", + "related": "listNetworkOfferings", + "required": true, + "type": "uuid" + }, + { + "description": "the display text of the network", + "length": 255, + "name": "displaytext", "required": false, - "since": "4.19", "type": "string" } ], "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "response": [ { - "description": "Tungsten-Fabric virtual router the network belongs to", - "name": "tungstenvirtualrouteruuid", + "description": "the domain id of the network owner", + "name": "domainid", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the list of services", + "name": "service", + "response": [ + { + "description": "the service provider name", + "name": "provider", + "response": [ + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", + "type": "string" + }, + { + "description": "the provider name", + "name": "name", + "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", + "type": "string" + }, + { + "description": "state of the network provider", + "name": "state", + "type": "string" + }, + { + "description": "uuid of the network provider", + "name": "id", + "type": "string" + } + ], + "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 value", + "name": "value", + "type": "string" + }, + { + "description": "the capability name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the service name", + "name": "name", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the traffic type of the network", + "name": "traffictype", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "true if network is system, false otherwise", + "name": "issystem", + "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": "related to what other network configuration", - "name": "related", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", + "type": "string" + }, + { + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { @@ -140523,23 +141430,23 @@ "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 project name where tag belongs to", - "name": "project", + "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 value", + "name": "value", "type": "string" }, { @@ -140548,344 +141455,248 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "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 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": "customer associated with the tag", - "name": "customer", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "list" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", - "type": "boolean" - }, - { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "network offering id the network is created from", + "name": "networkofferingid", "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "if network offering supports vm autoscaling feature", - "name": "supportsvmautoscaling", - "type": "boolean" + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", - "type": "string" + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "type": "long" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", + "description": "true network requires restart", + "name": "restartrequired", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "display text of the network offering the network is created from", + "name": "networkofferingdisplaytext", + "type": "string" }, - {}, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the domain id of the network owner", - "name": "domainid", + "description": "the network's netmask", + "name": "netmask", "type": "string" }, { - "description": "the name of the zone the network belongs to", - "name": "zonename", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "an optional field, whether to the display the network to the end user or not.", - "name": "displaynetwork", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", "type": "boolean" }, { - "description": "The external id of the network", - "name": "externalid", + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the traffic type of the network", - "name": "traffictype", + "description": "state of the network", + "name": "state", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "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 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": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "the details of the network", - "name": "details", - "type": "map" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "state of the network", - "name": "state", - "type": "string" + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", + "type": "boolean" }, { - "description": "the type of the network", - "name": "type", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", "type": "string" }, - { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" - }, { "description": "the domain name of the network owner", "name": "domain", "type": "string" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "the owner of the network", + "name": "account", "type": "string" }, { - "description": "the project name of the address", - "name": "project", - "type": "string" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "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 first IPv4 DNS for the network", - "name": "dns1", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", - "type": "string" + "description": "true if users from subdomains can access the domain level network", + "name": "subdomainaccess", + "type": "boolean" }, { - "description": "ACL name associated with the VPC network", - "name": "aclname", + "description": "the id of the network", + "name": "id", "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", + "description": "true if network is default, false otherwise", + "name": "isdefault", "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "The BGP peers for the network", + "name": "bgppeers", + "type": "set" }, { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "acl type - access type to the network", + "name": "acltype", "type": "string" }, { - "description": "the list of services", - "name": "service", - "response": [ - { - "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", - "name": "name", - "type": "string" - } - ], - "type": "list" - }, - { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "description": "uuid of the network provider", - "name": "id", - "type": "string" - }, - { - "description": "state of the network provider", - "name": "state", - "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" - }, - { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", - "type": "string" - }, - { - "description": "the provider name", - "name": "name", - "type": "string" - }, - { - "description": "services for this provider", - "name": "servicelist", - "type": "list" - } - ], - "type": "list" - } - ], - "type": "list" - }, - { - "description": "network offering id the network is created from", - "name": "networkofferingid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", + "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { "description": "the date this network was created", @@ -140893,59 +141704,49 @@ "type": "date" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", "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 guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" }, { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "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": "the second IPv4 DNS for the network", + "name": "dns2", + "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "the displaytext of the network", + "name": "displaytext", "type": "string" }, { - "description": "The routes for the network 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" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "the network's netmask", - "name": "netmask", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { "description": "the cidr of IPv6 network", @@ -140953,45 +141754,44 @@ "type": "string" }, { - "description": "the owner of the network", - "name": "account", + "description": "the network's gateway", + "name": "gateway", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, - {}, { - "description": "true if users from subdomains can access the domain level network", - "name": "subdomainaccess", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "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", + "description": "the name of the network", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "path of the Domain the network belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", + "type": "string" }, { - "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 a network is enabled for 'streched l2 subnet' then represents zones on which network currently spans", + "name": "zonesnetworkspans", + "type": "set" }, { "description": "MTU configured on the network VR's private interfaces", @@ -140999,24 +141799,40 @@ "type": "integer" }, { - "description": "MTU configured on the network VR's public facing interfaces", - "name": "publicmtu", - "type": "integer" + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", + "type": "string" + }, + {}, + { + "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", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", + "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 routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" + "description": "the network domain", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The internet protocol of network offering", + "name": "internetprotocol", + "type": "string" } ] }, @@ -141026,20 +141842,20 @@ "name": "listNetworkOfferings", "params": [ { - "description": "", + "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": "page", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "list network offerings available for network creation in specific domain", + "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "routingmode", "required": false, - "since": "4.13", - "type": "uuid" + "since": "4.20.0", + "type": "string" }, { "description": "the availability of network offering. Default value is required", @@ -141049,26 +141865,32 @@ "type": "string" }, { - "description": "true if need to list only network offerings which support specifying ip ranges", + "description": "", "length": 255, - "name": "specifyipranges", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list network offerings by display text", + "description": "list network offerings by tags", + "length": 4096, + "name": "tags", + "required": false, + "type": "string" + }, + { + "description": "list network offerings by name", "length": 255, - "name": "displaytext", + "name": "name", "required": false, "type": "string" }, { - "description": "list network offerings by ID", + "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", "length": 255, - "name": "id", - "related": "listNetworkOfferings", + "name": "sourcenatsupported", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "list network offerings by state", @@ -141078,155 +141900,184 @@ "type": "string" }, { - "description": "list network offerings available for network creation in specific zone", + "description": "true if offering has tags specified", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "istagged", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "true if offering has tags specified", + "description": "true if need to list only default network offerings. Default value is false", "length": 255, - "name": "istagged", + "name": "isdefault", "required": false, "type": "boolean" }, { - "description": "list network offerings by tags", - "length": 4096, - "name": "tags", + "description": "list network offerings by guest type: shared or isolated", + "length": 255, + "name": "guestiptype", "required": false, "type": "string" }, { - "description": "the tags for the network offering.", + "description": "list network offerings available for network creation in specific zone", "length": 255, - "name": "specifyvlan", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "true if need to list only netwok offerings where source NAT is supported, false otherwise", + "description": "", "length": 255, - "name": "sourcenatsupported", + "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 network offering can be used only for network creation inside the VPC", + "description": "true if need to list only network offerings which support specifying ip ranges", "length": 255, - "name": "forvpc", + "name": "specifyipranges", "required": false, "type": "boolean" }, { - "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.", + "description": "list network offerings available for network creation in specific domain", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "domainid", + "related": "listDomains", "required": false, + "since": "4.13", "type": "uuid" }, { - "description": "list network offerings by name", + "description": "list network offerings by display text", "length": 255, - "name": "name", + "name": "displaytext", "required": false, "type": "string" }, { - "description": "list by traffic type", + "description": "the network offering can be used only for network creation inside the VPC", "length": 255, - "name": "traffictype", + "name": "forvpc", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "list network offerings by guest type: shared or isolated", + "description": "list by traffic type", "length": 255, - "name": "guestiptype", + "name": "traffictype", "required": false, "type": "string" }, { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list network offerings supporting certain services", + "description": "the tags for the network offering.", "length": 255, - "name": "supportedservices", + "name": "specifyvlan", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "true if need to list only default network offerings. Default value is false", + "description": "List by keyword", "length": 255, - "name": "isdefault", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the routing mode for the network offering. Supported types are: Static or Dynamic.", + "description": "list network offerings by ID", "length": 255, - "name": "routingmode", + "name": "id", + "related": "listNetworkOfferings", "required": false, - "since": "4.20.0", - "type": "string" + "type": "uuid" } ], "related": "", "response": [ { - "description": "maximum number of concurrents connections to be handled by lb", - "name": "maxconnections", + "description": "true if network offering supports persistent networks, false otherwise", + "name": "ispersistent", + "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": "availability of the network offering", + "name": "availability", "type": "string" }, { - "description": "the tags for the network offering", - "name": "tags", + "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 id of the network offering", - "name": "id", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "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": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", + "description": "an alternate display text of the network offering.", + "name": "displaytext", + "type": "string" + }, + { + "description": "true if network offering supports vlans, false otherwise", + "name": "specifyvlan", "type": "boolean" }, + { + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the ID of the service offering used by virtual router provider", "name": "serviceofferingid", "type": "string" }, + { + "description": "guest type of the network offering, can be Shared or Isolated", + "name": "guestiptype", + "type": "string" + }, + { + "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", + "name": "networkmode", + "type": "string" + }, { "description": "additional key/value details tied with network offering", "name": "details", "type": "map" }, - {}, { - "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" }, { @@ -141234,90 +142085,106 @@ "name": "domainid", "type": "string" }, + { + "description": "the name of the network offering", + "name": "name", + "type": "string" + }, + { + "description": "the internet protocol of the network offering", + "name": "internetprotocol", + "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": "the tags for the network offering", + "name": "tags", + "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 VPC networks only", - "name": "forvpc", + "description": "true if network offering can be used by Tungsten-Fabric networks only", + "name": "fortungsten", "type": "boolean" }, { - "description": "true if network offering supports public access for guest networks", - "name": "supportspublicaccess", + "description": "true if network offering supports choosing AS numbers", + "name": "specifyasnumber", "type": "boolean" }, { - "description": "true if network offering supports persistent networks, false otherwise", - "name": "ispersistent", + "description": "true if network offering supports network that span multiple zones", + "name": "supportsstrechedl2subnet", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "true if network offering can be used by NSX networks only", + "name": "fornsx", "type": "boolean" }, + {}, { - "description": "availability of the network offering", - "name": "availability", - "type": "string" - }, - { - "description": "an alternate display text of the network offering.", - "name": "displaytext", - "type": "string" + "description": "maximum number of concurrents connections to be handled by lb", + "name": "maxconnections", + "type": "integer" }, { - "description": "true if network offering is default, false otherwise", - "name": "isdefault", + "description": "true if network offering supports public access for guest networks", + "name": "supportspublicaccess", "type": "boolean" }, { - "description": "Mode in which the network will operate. The valid values are NATTED and ROUTED", - "name": "networkmode", - "type": "string" + "description": "the date this network offering was created", + "name": "created", + "type": "date" }, { - "description": "true if network offering supports choosing AS numbers", - "name": "specifyasnumber", + "description": "true if network offering can be used by VPC networks only", + "name": "forvpc", "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 id of the network offering", + "name": "id", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "description": "true if network offering supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "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": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "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": "true if network offering can be used by NSX networks only", - "name": "fornsx", - "type": "boolean" + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", + "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 network offering. Can be Disabled/Enabled/Inactive", + "name": "state", "type": "string" }, { - "description": "the date this network offering was created", - "name": "created", - "type": "date" + "description": "true if network offering is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the list of supported services", @@ -141328,9 +142195,9 @@ "name": "provider", "response": [ { - "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", @@ -141338,29 +142205,29 @@ "type": "string" }, { - "description": "uuid of the network provider", - "name": "id", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "state of the network provider", + "name": "state", "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", + "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" } ], "type": "list" @@ -141370,13 +142237,13 @@ "name": "capability", "response": [ { - "description": "the capability name", - "name": "name", + "description": "the capability value", + "name": "value", "type": "string" }, { - "description": "the capability value", - "name": "value", + "description": "the capability name", + "name": "name", "type": "string" }, { @@ -141394,57 +142261,6 @@ } ], "type": "list" - }, - { - "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": "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": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", - "type": "string" - }, - { - "description": "the internet protocol of the network offering", - "name": "internetprotocol", - "type": "string" - }, - { - "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" } ] }, @@ -141454,34 +142270,34 @@ "name": "listDedicatedPods", "params": [ { - "description": "the name of the account associated with the pod. Must be used with domainId.", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "list dedicated pods by affinity group", + "description": "the ID of the pod", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": false, "type": "uuid" }, { - "description": "List by keyword", + "description": "list dedicated pods by affinity group", "length": 255, - "name": "keyword", + "name": "affinitygroupid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the pod", + "description": "", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "", @@ -141491,11 +142307,11 @@ "type": "integer" }, { - "description": "", + "description": "the name of the account associated with the pod. Must be used with domainId.", "length": 255, - "name": "page", + "name": "account", "required": false, - "type": "integer" + "type": "string" }, { "description": "the ID of the domain associated with the pod", @@ -141509,19 +142325,18 @@ "related": "", "response": [ { - "description": "the Name of the Pod", - "name": "podname", + "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 Dedication Affinity Group ID of the pod", - "name": "affinitygroupid", + "description": "the Account Id to which the Pod is dedicated", + "name": "accountid", "type": "string" }, { @@ -141530,24 +142345,25 @@ "type": "integer" }, { - "description": "the domain ID to which the Pod is dedicated", - "name": "domainid", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Dedication Affinity Group ID of the pod", + "name": "affinitygroupid", "type": "string" }, {}, + {}, { - "description": "the ID of the Pod", - "name": "podid", + "description": "the Name of the Pod", + "name": "podname", "type": "string" } ] @@ -141558,32 +142374,33 @@ "name": "listVPCs", "params": [ { - "description": "List resources by tags (key/value pairs)", + "description": "list VPC supporting certain services", "length": 255, - "name": "tags", + "name": "supportedservices", "required": false, - "type": "map" + "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 only resources belonging to the domain specified", "length": 255, - "name": "listall", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "list VPC supporting certain services", + "description": "flag to display the resource icon for VPCs", "length": 255, - "name": "supportedservices", + "name": "showicon", "required": false, - "type": "list" + "type": "boolean" }, { - "description": "flag to display the resource icon for VPCs", + "description": "", "length": 255, - "name": "showicon", + "name": "pagesize", "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.", @@ -141593,19 +142410,18 @@ "type": "boolean" }, { - "description": "list VPCs by restartRequired option", + "description": "List by display text of the VPC", "length": 255, - "name": "restartrequired", + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "list VPC by id", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listVPCs,createVPC,listVPCs,updateVPC", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { "description": "list by ID of the VPC offering", @@ -141616,17 +142432,25 @@ "type": "uuid" }, { - "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", + "description": "list by zone", "length": 255, - "name": "cidr", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "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": "", + "name": "listall", + "required": false, + "type": "boolean" + }, + { + "description": "list VPC by id", + "length": 255, + "name": "id", + "related": "listVPCs,createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, @@ -141638,102 +142462,69 @@ "type": "string" }, { - "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 resources by account. Must be used with the domainId parameter.", + "description": "list by name of the VPC", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list by cidr of the VPC. All VPC guest networks' cidrs should be within this CIDR", "length": 255, - "name": "fordisplay", + "name": "cidr", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "", + "description": "list VPCs by restartRequired option", "length": 255, - "name": "page", + "name": "restartrequired", "required": false, - "type": "integer" + "type": "boolean" }, { - "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": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, - { - "description": "list by name of the VPC", + "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 display text of the VPC", + "description": "", "length": 255, - "name": "displaytext", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "List by keyword", + "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "keyword", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" } ], "related": "createVPC,listVPCs,updateVPC", "response": [ { - "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": "vpc offering name the VPC is created from", - "name": "vpcofferingname", - "type": "string" - }, - { - "description": "is vpc for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the first IPv6 DNS for the VPC", - "name": "ip6dns1", + "description": "the name of the VPC", + "name": "name", "type": "string" }, { @@ -141741,19 +142532,10 @@ "name": "domainpath", "type": "string" }, + {}, { - "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": "UUID of AS NUMBER", - "name": "asnumberid", + "description": "the name of the zone the VPC belongs to", + "name": "zonename", "type": "string" }, { @@ -141761,95 +142543,19 @@ "name": "icon", "type": "resourceiconresponse" }, - { - "description": "if this VPC has redundant router", - "name": "redundantvpcrouter", - "type": "boolean" - }, - { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip6routes", - "type": "set" - }, - { - "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 first IPv4 DNS for the VPC", - "name": "dns1", - "type": "string" - }, - { - "description": "the project id of the VPC", - "name": "projectid", - "type": "string" - }, - { - "description": "the date this VPC was created", - "name": "created", - "type": "date" - }, - { - "description": "the domain id of the VPC owner", - "name": "domainid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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", - "name": "ip4routing", - "type": "string" - }, - { - "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 service name", + "name": "name", + "type": "string" + }, { "description": "the service provider name", "name": "provider", "response": [ - { - "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", @@ -141865,28 +142571,38 @@ "name": "state", "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 physical network this belongs to", + "name": "physicalnetworkid", + "type": "string" + }, + { + "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 name", + "name": "name", + "type": "string" + }, { "description": "the capability value", "name": "value", @@ -141896,11 +142612,6 @@ "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" @@ -141909,28 +142620,23 @@ "type": "list" }, { - "description": "the list of networks belongign to the VPC", - "name": "network", - "type": "list" - }, - { - "description": "the name of the VPC", - "name": "name", + "description": "state of the VPC. Can be Inactive/Enabled", + "name": "state", "type": "string" }, { - "description": "The BGP peers for the VPC", - "name": "bgppeers", - "type": "set" + "description": "vpc offering id the VPC is created from", + "name": "vpcofferingid", + "type": "string" }, { - "description": "the cidr the VPC", - "name": "cidr", + "description": "an alternate display text of the VPC.", + "name": "displaytext", "type": "string" }, { - "description": "the id of the VPC", - "name": "id", + "description": "zone id of the vpc", + "name": "zoneid", "type": "string" }, { @@ -141939,34 +142645,54 @@ "type": "string" }, { - "description": "the second IPv4 DNS for the VPC", - "name": "dns2", + "description": "vpc offering name the VPC is created from", + "name": "vpcofferingname", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "UUID of AS NUMBER", + "name": "asnumberid", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the VPC", + "name": "ip6dns1", + "type": "string" }, {}, { - "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", - "name": "distributedvpcrouter", + "description": "MTU configured on the public interfaces of the VPC VR", + "name": "publicmtu", + "type": "integer" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the domain name of the owner", - "name": "domain", + "description": "the date this VPC was created", + "name": "created", + "type": "date" + }, + { + "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 second IPv6 DNS for the VPC", + "name": "ip6dns2", + "type": "string" }, { - "description": "an alternate display text of the VPC.", - "name": "displaytext", + "description": "true if VPC is region level", + "name": "regionlevelvpc", + "type": "boolean" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -141974,67 +142700,157 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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": "tag key name", - "name": "key", + "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 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": "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "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": "tag value", + "name": "value", "type": "string" } ], "type": "list" }, { - "description": "true if VPC is region level", - "name": "regionlevelvpc", + "description": "the network domain of the VPC", + "name": "networkdomain", + "type": "string" + }, + { + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip6routes", + "type": "set" + }, + { + "description": "The IPv4 routing mode of VPC", + "name": "ip4routing", + "type": "string" + }, + { + "description": "the project name of the VPC", + "name": "project", + "type": "string" + }, + { + "description": "true VPC requires restart", + "name": "restartrequired", + "type": "boolean" + }, + { + "description": "the id of the VPC", + "name": "id", + "type": "string" + }, + { + "description": "the domain id of the VPC owner", + "name": "domainid", + "type": "string" + }, + { + "description": "is VPC uses distributed router for one hop forwarding and host based network ACL's", + "name": "distributedvpcrouter", + "type": "boolean" + }, + { + "description": "the first IPv4 DNS for the VPC", + "name": "dns1", + "type": "string" + }, + { + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" + }, + { + "description": "is vpc for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "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": "the cidr the VPC", + "name": "cidr", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "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 VPC to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" + }, + { + "description": "The BGP peers for the VPC", + "name": "bgppeers", + "type": "set" } ] }, @@ -142044,18 +142860,18 @@ "name": "addNetworkDevice", "params": [ { - "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" }, { - "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" } ], "related": "", @@ -142065,18 +142881,18 @@ "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + } ] }, { @@ -142084,14 +142900,6 @@ "isasync": true, "name": "runDiagnostics", "params": [ - { - "description": "The ID of the system VM instance to diagnose", - "length": 255, - "name": "targetid", - "related": "startSystemVm", - "required": true, - "type": "uuid" - }, { "description": "Additional command line options that apply for each command", "length": 255, @@ -142112,15 +142920,18 @@ "name": "ipaddress", "required": true, "type": "string" + }, + { + "description": "The ID of the system VM instance to diagnose", + "length": 255, + "name": "targetid", + "related": "startSystemVm", + "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", @@ -142131,18 +142942,23 @@ "name": "stdout", "type": "string" }, + {}, { - "description": "the command execution return code", - "name": "exitcode", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { "description": "the standard error output from the command execution", "name": "stderr", "type": "string" - } + }, + { + "description": "the command execution return code", + "name": "exitcode", + "type": "string" + }, + {} ], "since": "4.12.0.0" }, @@ -142152,17 +142968,11 @@ "name": "restartVPC", "params": [ { - "description": "Turn a single VPC into a redundant one.", - "length": 255, - "name": "makeredundant", - "required": false, - "type": "boolean" - }, - { - "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" }, { @@ -142174,21 +142984,26 @@ "type": "uuid" }, { - "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, + "type": "boolean" + }, + { + "description": "Turn a single VPC into a redundant one.", + "length": 255, + "name": "makeredundant", "required": false, - "since": "4.17.0", "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", @@ -142199,12 +143014,13 @@ "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" + }, + {}, + {} ] }, { @@ -142213,18 +143029,25 @@ "name": "quotaConfigureEmail", "params": [ { - "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": "If the quota email template should be enabled", + "description": "New quota account min balance", "length": 255, - "name": "enable", + "name": "minbalance", "required": false, - "type": "boolean" + "type": "double" + }, + { + "description": "Quota email template name which should be configured", + "length": 255, + "name": "templatename", + "required": false, + "type": "string" }, { "description": "Account ID for which to configure quota template email or min balance", @@ -142233,49 +143056,42 @@ "related": "enableAccount,listAccounts", "required": true, "type": "uuid" - }, - { - "description": "New quota account min balance", - "length": 255, - "name": "minbalance", - "required": false, - "type": "double" } ], - "related": "", - "response": [ - { - "description": "The configured account's min balance.", - "name": "minbalance", - "type": "double" - }, - {}, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, + "related": "", + "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The template's name.", + "name": "templatename", "type": "string" }, - {}, { "description": "The configured account's id.", "name": "account", "type": "string" }, { - "description": "The template's name.", - "name": "templatename", + "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 the template is enabled.", "name": "enabled", "type": "boolean" - } + }, + { + "description": "The configured account's min balance.", + "name": "minbalance", + "type": "double" + }, + {} ], "since": "4.20.0.0" }, @@ -142292,50 +143108,45 @@ "type": "string" }, { - "description": "URL of the external dhcp appliance.", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "url", + "name": "password", "required": true, "type": "string" }, { - "description": "Credentials to reach external dhcp device", + "description": "the Physical Network ID", "length": 255, - "name": "username", + "name": "physicalnetworkid", + "related": "", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "Credentials to reach external dhcp device", + "description": "URL of the external dhcp appliance.", "length": 255, - "name": "password", + "name": "url", "required": true, "type": "string" }, { - "description": "the Physical Network ID", + "description": "Credentials to reach external dhcp device", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "username", "required": true, - "type": "uuid" + "type": "string" } ], "related": "listBaremetalDhcp", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 id of ", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -142344,22 +143155,27 @@ "type": "string" }, { - "description": "url", - "name": "url", + "description": "name of the provider", + "name": "dhcpservertype", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "url", + "name": "url", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "dhcpservertype", + "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" + } ] }, { @@ -142384,7 +143200,6 @@ } ], "response": [ - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -142395,16 +143210,17 @@ "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" + }, {} ] }, @@ -142413,14 +143229,6 @@ "isasync": true, "name": "copySnapshot", "params": [ - { - "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, - "name": "sourcezoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, { "description": "The ID of the zone the snapshot is being copied to.", "length": 255, @@ -142454,6 +143262,14 @@ "since": "4.21.0", "type": "list" }, + { + "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, + "name": "sourcezoneid", + "related": "listZones", + "required": false, + "type": "uuid" + }, { "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, @@ -142466,148 +143282,64 @@ "related": "listSnapshots", "response": [ { - "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 date the snapshot was created", + "name": "created", + "type": "date" }, { - "description": "ID of the snapshot", - "name": "id", + "description": "the domain name of the snapshot's account", + "name": "domain", "type": "string" }, { - "description": "path of the Domain the snapshot's account belongs to", - "name": "domainpath", + "description": "state of the disk volume", + "name": "volumestate", "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": "type of the disk volume", - "name": "volumetype", + "description": "name of the snapshot", + "name": "name", "type": "string" }, - {}, { - "description": "the account associated with the snapshot", - "name": "account", - "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 availability zone", - "name": "zoneid", + "description": "name of the datastore for the snapshot entry", + "name": "datastorename", "type": "string" }, { - "description": "physical size of backedup snapshot on image store", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the project name of the snapshot", - "name": "project", + "description": "ID of the snapshot", + "name": "id", "type": "string" }, { - "description": "name of the snapshot", - "name": "name", + "description": "name of the disk volume", + "name": "volumename", "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", + "description": "valid types are hourly, daily, weekly, monthy, template, and none.", + "name": "intervaltype", "type": "string" }, { - "description": "valid location types are primary and secondary.", - "name": "locationtype", + "description": "display name of the os on volume", + "name": "osdisplayname", "type": "string" }, { - "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 status of the template", + "name": "status", + "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", + "type": "string" }, { "description": "the domain ID of the snapshot's account", @@ -142615,64 +143347,138 @@ "type": "string" }, { - "description": "the domain name of the snapshot's account", - "name": "domain", + "description": "the account associated with the snapshot", + "name": "account", "type": "string" }, { - "description": "the type of the snapshot", - "name": "snapshottype", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "ID of the datastore for the snapshot entry", - "name": "datastoreid", + "description": "the project id of the snapshot", + "name": "projectid", "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": "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 disk volume", "name": "volumeid", "type": "string" }, + {}, { - "description": "name of the datastore for the snapshot entry", - "name": "datastorename", + "description": "type of the disk volume", + "name": "volumetype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "indicates whether the underlying storage supports reverting the volume to this snapshot", + "name": "revertable", "type": "boolean" }, { - "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 datastore for the snapshot entry", - "name": "datastoretype", + "description": "download progress of a snapshot", + "name": "downloaddetails", + "type": "map" + }, + { + "description": "the project name of the snapshot", + "name": "project", "type": "string" }, + {}, { - "description": "state of the disk volume", - "name": "volumestate", + "description": "valid location types are primary and secondary.", + "name": "locationtype", "type": "string" }, + { + "description": "physical size of backedup snapshot on image store", + "name": "physicalsize", + "type": "long" + }, { "description": "state of the snapshot on the datastore", "name": "datastorestate", "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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "the project name where tag belongs to", + "name": "project", + "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 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" + } + ], + "type": "set" }, { "description": "id of the os on volume", @@ -142680,23 +143486,33 @@ "type": "string" }, { - "description": "valid types are hourly, daily, weekly, monthy, template, and none.", - "name": "intervaltype", + "description": "path of the Domain the snapshot's account belongs to", + "name": "domainpath", "type": "string" }, { - "description": "display name of the os on volume", - "name": "osdisplayname", + "description": "ID of the datastore for the snapshot entry", + "name": "datastoreid", "type": "string" }, { - "description": "download progress of a snapshot", - "name": "downloaddetails", - "type": "map" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "id of the availability zone", + "name": "zoneid", + "type": "string" + }, + { + "description": "the type of the snapshot", + "name": "snapshottype", "type": "string" } ], @@ -142715,11 +143531,12 @@ "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" }, { "description": "Traffic going into the listed zones will be metered", @@ -142729,19 +143546,23 @@ "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" } ], "related": "", "response": [ { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -142749,31 +143570,26 @@ "name": "numretries", "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 firewall", - "name": "ipaddress", - "type": "string" - }, - { - "description": "the ID of the external firewall", - "name": "id", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, + {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" } ] @@ -142784,62 +143600,56 @@ "name": "listUsers", "params": [ { - "description": "List users by state of the user account.", + "description": "List by keyword", "length": 255, - "name": "state", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List user by ID.", "length": 255, - "name": "page", + "name": "id", + "related": "disableUser,getUser,listUsers", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "flag to display the resource icon for users", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "showicon", + "name": "isrecursive", "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": "List users by the Api key access value", + "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", "length": 255, - "name": "apikeyaccess", + "name": "usersource", "required": false, - "since": "4.20.1.0", + "since": "4.21.0.0", "type": "string" }, { - "description": "List user by ID.", - "length": 255, - "name": "id", - "related": "disableUser,getUser,listUsers", - "required": false, - "type": "uuid" - }, - { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "List users by the Api key access value", "length": 255, - "name": "account", + "name": "apikeyaccess", "required": false, + "since": "4.20.1.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": "", "length": 255, - "name": "listall", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { "description": "", @@ -142857,26 +143667,32 @@ "type": "uuid" }, { - "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", + "description": "flag to display the resource icon for users", "length": 255, - "name": "accounttype", + "name": "showicon", "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": "List users by state of the user account.", "length": 255, - "name": "isrecursive", + "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.", + "length": 255, + "name": "listall", "required": false, "type": "boolean" }, { - "description": "List users by their authentication source. Valid values are: native, ldap, saml2 and saml2disabled.", + "description": "List users by account type. Valid types include admin, domain-admin, read-only-admin, or user.", "length": 255, - "name": "usersource", + "name": "accounttype", "required": false, - "since": "4.21.0.0", - "type": "string" + "type": "integer" }, { "description": "List user by the username", @@ -142889,18 +143705,18 @@ "related": "disableUser,getUser", "response": [ { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the user lastname", + "name": "lastname", + "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { @@ -142909,79 +143725,73 @@ "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 timezone user was created in", + "name": "timezone", + "type": "string" }, { - "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 timezone user was created in", - "name": "timezone", + "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", - "type": "string" + "description": "the date and time the user account was created", + "name": "created", + "type": "date" }, { - "description": "the type of the role", - "name": "roletype", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the api key of the user", - "name": "apikey", + "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 user state", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "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 account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the user lastname", - "name": "lastname", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the user ID", - "name": "id", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -142989,41 +143799,47 @@ "name": "isdefault", "type": "boolean" }, + {}, { - "description": "the account ID of the user", - "name": "accountid", - "type": "string" + "description": "the account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the user email address", - "name": "email", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", - "type": "boolean" - }, - { - "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 ID of the role", - "name": "roleid", + "description": "the account name of the user", + "name": "account", "type": "string" }, { - "description": "the user state", - "name": "state", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", + "type": "string" } ] }, @@ -143033,9 +143849,9 @@ "name": "updateVlanIpRange", "params": [ { - "description": "the ending IPv6 address in the IPv6 network range", + "description": "the gateway of the VLAN IP range", "length": 255, - "name": "endipv6", + "name": "gateway", "required": false, "type": "string" }, @@ -143047,19 +143863,26 @@ "type": "string" }, { - "description": "true if IP range is set to system vms, false if not", + "description": "the beginning IPv6 address in the IPv6 network range", "length": 255, - "name": "forsystemvms", + "name": "startipv6", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "the ending IP address in the VLAN IP range", + "description": "the netmask of the VLAN IP range", "length": 255, - "name": "endip", + "name": "netmask", "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, @@ -143068,13 +143891,6 @@ "required": true, "type": "uuid" }, - { - "description": "the netmask of the VLAN IP range", - "length": 255, - "name": "netmask", - "required": false, - "type": "string" - }, { "description": "the CIDR of IPv6 network, must be at least /64", "length": 255, @@ -143083,23 +143899,23 @@ "type": "string" }, { - "description": "the gateway of the VLAN IP range", + "description": "the ending IPv6 address in the IPv6 network range", "length": 255, - "name": "gateway", + "name": "endipv6", "required": false, "type": "string" }, { - "description": "the beginning IPv6 address in the IPv6 network range", + "description": "the beginning IP address in the VLAN IP range", "length": 255, - "name": "startipv6", + "name": "startip", "required": false, "type": "string" }, { - "description": "the beginning IP address in the VLAN IP range", + "description": "the ending IP address in the VLAN IP range", "length": 255, - "name": "startip", + "name": "endip", "required": false, "type": "string" } @@ -143107,135 +143923,130 @@ "related": "", "response": [ { - "description": "the domain name of the VLAN IP range", - "name": "domain", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the network id of vlan range", - "name": "networkid", + "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 physical network this belongs to", - "name": "physicalnetworkid", + "description": "the start ipv6 of the VLAN IP range", + "name": "startipv6", "type": "string" }, { - "description": "the Zone ID of the VLAN IP range", - "name": "zoneid", + "description": "the Pod name for the VLAN IP range", + "name": "podname", "type": "string" }, { - "description": "the end ip of the VLAN IP range", - "name": "endip", + "description": "the cidr of the VLAN IP range", + "name": "cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the Zone ID of the VLAN IP range", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the account of the VLAN IP range", + "name": "account", "type": "string" }, { - "description": "the ID of the VLAN IP range", - "name": "id", + "description": "the project name of the vlan range", + "name": "project", "type": "string" }, { - "description": "the description of the VLAN IP range", - "name": "description", + "description": "the netmask of the VLAN 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 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": "path of the domain to which the VLAN IP range belongs", - "name": "domainpath", + "description": "the ID or VID of the VLAN.", + "name": "vlan", "type": "string" }, { - "description": "the account of the VLAN IP range", - "name": "account", + "description": "the end ipv6 of the VLAN IP range", + "name": "endipv6", "type": "string" }, - {}, { - "description": "the Pod name for the VLAN IP range", - "name": "podname", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "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 start ipv6 of the VLAN IP range", - "name": "startipv6", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, + {}, + {}, { - "description": "the end ipv6 of the VLAN IP range", - "name": "endipv6", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "indicates to which provider the IP range is dedicated to", - "name": "provider", + "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 ID of the VLAN IP range", + "name": "id", + "type": "string" }, - {}, { - "description": "the project id of the vlan range", - "name": "projectid", + "description": "the network id of vlan range", + "name": "networkid", "type": "string" }, { - "description": "the project name of the vlan range", - "name": "project", + "description": "the end ip of the VLAN IP range", + "name": "endip", "type": "string" }, { - "description": "the gateway of the VLAN IP range", - "name": "gateway", + "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 project id of the vlan range", + "name": "projectid", "type": "string" }, { @@ -143244,8 +144055,13 @@ "type": "string" }, { - "description": "the Pod ID for the VLAN IP range", - "name": "podid", + "description": "indicates whether VLAN IP range is dedicated to system vms or not", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the domain ID of the VLAN IP range", + "name": "domainid", "type": "string" } ], @@ -143257,62 +144073,62 @@ "name": "listResourceLimits", "params": [ { - "description": "list only resources belonging to the domain specified", + "description": "Tag for the resource type", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "tag", "required": false, - "type": "uuid" + "since": "4.20.0", + "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": "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": "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": "listall", + "name": "resourcetype", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", "length": 255, - "name": "projectid", - "related": "", + "name": "resourcetypename", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "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": "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 resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "Type of resource (wins over resourceType if both are provided). Values are: user_vm - Instance. Number of instances a user can create. public_ip - IP. Number of public IP addresses an account can own. volume - Volume. Number of disk volumes an account can own. snapshot - Snapshot. Number of snapshots an account can own. template - Template. Number of templates an account can register/create. project - Project. Number of projects an account can own. network - Network. Number of networks an account can own. vpc - VPC. Number of VPC an account can own. cpu - CPU. Number of CPU an account can allocate for their resources. memory - Memory. Amount of RAM an account can allocate for their resources. primary_storage - PrimaryStorage. Total primary storage space (in GiB) a user can use. secondary_storage - SecondaryStorage. Total secondary storage space (in GiB) a user can use. ", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "resourcetypename", + "name": "isrecursive", "required": false, - "type": "string" + "type": "boolean" }, { "description": "", @@ -143322,55 +144138,55 @@ "type": "integer" }, { - "description": "Tag for the resource type", + "description": "Lists resource limits by ID.", "length": 255, - "name": "tag", + "name": "id", "required": false, - "since": "4.20.0", - "type": "string" + "type": "long" }, { - "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 objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "resourcetype", + "name": "projectid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "Lists resource limits by ID.", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, - "type": "long" + "type": "string" } ], "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 account of the resource limit", + "name": "account", "type": "string" }, { - "description": "The tag for the resource limit", - "name": "tag", - "type": "string" + "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", + "name": "max", + "type": "long" }, {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, { - "description": "the project name of the resource limit", - "name": "project", + "description": "the domain ID of the resource limit", + "name": "domainid", "type": "string" }, { - "description": "the account of the resource limit", - "name": "account", + "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" }, { @@ -143379,24 +144195,24 @@ "type": "string" }, { - "description": "the maximum number of the resource. A -1 means the resource currently has no limit.", - "name": "max", - "type": "long" + "description": "the project name of the resource limit", + "name": "project", + "type": "string" }, { - "description": "the domain ID of the resource limit", - "name": "domainid", - "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 resource limit", - "name": "projectid", + "description": "the domain name of the resource limit", + "name": "domain", "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", + "type": "string" }, { "description": "path of the domain to which the resource limit belongs", @@ -143404,8 +144220,8 @@ "type": "string" }, { - "description": "the domain name of the resource limit", - "name": "domain", + "description": "the project id of the resource limit", + "name": "projectid", "type": "string" } ] @@ -143427,130 +144243,125 @@ "related": "getUser", "response": [ { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "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" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the user ID", + "name": "id", "type": "string" }, { - "description": "the user name", - "name": "username", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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 api key of the user", - "name": "apikey", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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": "the domain ID of the user", - "name": "domainid", + "description": "the user state", + "name": "state", "type": "string" }, - {}, { "description": "true if user has two factor authentication enabled", "name": "is2faenabled", "type": "boolean" }, - {}, { - "description": "the name of the role", - "name": "rolename", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "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": "the user email address", "name": "email", "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, + {}, { - "description": "true if user is default, false otherwise", - "name": "isdefault", + "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", + "description": "the secret key of the user", + "name": "secretkey", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" }, { - "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 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 type of the role", - "name": "roletype", + "description": "the user name", + "name": "username", "type": "string" }, { @@ -143559,8 +144370,13 @@ "type": "string" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the account ID of the user", + "name": "accountid", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -143580,64 +144396,59 @@ "type": "uuid" }, { - "description": "list ISOs that are ready to be deployed", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "isready", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the hypervisor for which to restrict the search", + "description": "list ISO by ID", "length": 255, - "name": "hypervisor", + "name": "id", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "List by keyword", + "description": "ID of the storage pool", "length": 255, - "name": "keyword", + "name": "storageid", + "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", "required": false, - "type": "string" + "since": "4.19", + "type": "uuid" }, { - "description": "", + "description": "ID of the image or image cache store", "length": 255, - "name": "page", + "name": "imagestoreid", + "related": "listSwifts", "required": false, - "type": "integer" + "since": "4.19", + "type": "uuid" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "flag to display the resource image for the isos", "length": 255, - "name": "isrecursive", + "name": "showicon", "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 objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "ID of the image or image cache store", + "description": "list ISOs that are ready to be deployed", "length": 255, - "name": "imagestoreid", - "related": "listSwifts", + "name": "isready", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { "description": "the CPU arch of the ISO. Valid options are: x86_64, aarch64", @@ -143648,63 +144459,73 @@ "type": "string" }, { - "description": "the ID of the zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "If set to true, list only unique isos across zones", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "showunique", + "name": "tags", "required": false, - "since": "4.13.2", - "type": "boolean" + "type": "map" }, { - "description": "ID of the storage pool", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "storageid", - "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool", + "name": "isrecursive", "required": false, - "since": "4.19", - "type": "uuid" + "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "", "length": 255, - "name": "account", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "show removed ISOs as well", + "description": "true if the ISO is publicly available to all users, false otherwise.", "length": 255, - "name": "showremoved", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the hypervisor for which to restrict the search", "length": 255, - "name": "tags", + "name": "hypervisor", "required": false, - "type": "map" + "type": "string" }, { - "description": "list ISO by 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": "id", - "related": "listIsos,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "isofilter", + "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": "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": "list all ISOs by name", + "length": 255, + "name": "name", "required": false, "type": "string" }, @@ -143716,10 +144537,11 @@ "type": "boolean" }, { - "description": "flag to display the resource image for the isos", + "description": "If set to true, list only unique isos across zones", "length": 255, - "name": "showicon", + "name": "showunique", "required": false, + "since": "4.13.2", "type": "boolean" }, { @@ -143730,42 +144552,51 @@ "type": "boolean" }, { - "description": "list all ISOs by name", + "description": "the ID of the zone", "length": 255, - "name": "name", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "true if the ISO is publicly available to all users, false otherwise.", + "description": "show removed ISOs as well", "length": 255, - "name": "ispublic", + "name": "showremoved", "required": false, "type": "boolean" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "response": [ { - "description": "the template name", - "name": "name", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the name of the OS type for this template.", - "name": "ostypename", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "type": "string" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { @@ -143774,18 +144605,28 @@ "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 created", + "name": "created", + "type": "date" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" + "description": "The ID of extension linked to this template", + "name": "extensionid", + "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "the status of the template", + "name": "status", + "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 for this template", + "name": "zoneid", "type": "string" }, { @@ -143793,8 +144634,13 @@ "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -143803,8 +144649,8 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -143813,13 +144659,13 @@ "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -143828,62 +144674,57 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "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 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": "tag value", + "name": "value", "type": "string" } ], "type": "set" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, + {}, { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "the name of the zone for this template", + "name": "zonename", + "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", + "type": "string" }, { - "description": "the ID of the OS type for this template.", - "name": "ostypeid", + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "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 created", - "name": "created", - "type": "date" + "description": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "true if this template is a public template, false otherwise", - "name": "ispublic", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { @@ -143891,104 +144732,90 @@ "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 format of the template.", + "name": "format", + "type": "imageformat" }, { - "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": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { - "description": "CPU Arch of the template", - "name": "arch", + "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 account name to which the template belongs", - "name": "account", + "description": "the id of userdata linked to this template", + "name": "userdataid", "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", + "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 template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "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 userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", + "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 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": "the date this template was removed", + "name": "removed", + "type": "date" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "name": "isfeatured", + "type": "boolean" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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", + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the tag of this template", + "name": "templatetag", "type": "string" }, { @@ -143997,115 +144824,104 @@ "type": "resourceiconresponse" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "the template display text", + "name": "displaytext", "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 size of the template", + "name": "size", + "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the URL which the template/iso is registered from", + "name": "url", "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": "the account id to which the template belongs", + "name": "accountid", + "type": "string" }, + {}, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", "type": "boolean" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", - "type": "string" + "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": "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 name of the OS type for this template.", + "name": "ostypename", + "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" }, { - "description": "the template display text", - "name": "displaytext", - "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 format of the template.", - "name": "format", - "type": "imageformat" + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", + "type": "boolean" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "description": "CPU Arch of the template", + "name": "arch", "type": "string" }, - {}, { - "description": "the project name of the template", - "name": "project", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "type": "string" }, { - "description": "additional key/value details tied with template", - "name": "details", - "type": "map" + "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 the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, - {}, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "The name of extension linked to this template", + "name": "extensionname", "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 name", + "name": "name", + "type": "string" + }, + { + "description": "checksum of the template", + "name": "checksum", "type": "string" } ] @@ -144116,33 +144932,25 @@ "name": "listAutoScalePolicies", "params": [ { - "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": "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 objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "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": "the ID of the autoscale vm group", @@ -144153,25 +144961,34 @@ "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": "", + "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": "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": "the name of the autoscale policy", + "length": 255, + "name": "name", + "required": false, + "since": "4.18.0", + "type": "string" }, { "description": "the ID of the condition of the policy", @@ -144189,14 +145006,6 @@ "required": false, "type": "uuid" }, - { - "description": "the name of the autoscale policy", - "length": 255, - "name": "name", - "required": false, - "since": "4.18.0", - "type": "string" - }, { "description": "the action to be executed if all the conditions evaluate to true for the specified duration.", "length": 255, @@ -144211,6 +145020,13 @@ "related": "listAutoScalePolicies", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", @@ -144221,8 +145037,14 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "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" }, { @@ -144231,24 +145053,23 @@ "type": "integer" }, { - "description": "the project id autoscale policy", - "name": "projectid", + "description": "the account owning the autoscale policy", + "name": "account", "type": "string" }, - {}, { - "description": "the project name of the autoscale policy", - "name": "project", + "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 project id autoscale policy", + "name": "projectid", "type": "string" }, { - "description": "the cool down period for which the policy should not be evaluated after the action has been taken", - "name": "quiettime", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { @@ -144257,34 +145078,29 @@ "type": "list" }, { - "description": "the account owning the autoscale policy", - "name": "account", + "description": "the autoscale policy ID", + "name": "id", "type": "string" }, + {}, { - "description": "path of the domain to which the autoscale policy belongs", - "name": "domainpath", + "description": "the domain name of the autoscale policy", + "name": "domain", "type": "string" }, { - "description": "the domain ID of the autoscale policy", - "name": "domainid", + "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", "type": "string" }, { - "description": "the autoscale policy ID", - "name": "id", - "type": "string" - }, - { - "description": "name of the autoscale policy", - "name": "name", + "description": "the project name of the autoscale policy", + "name": "project", "type": "string" } ] @@ -144294,13 +145110,6 @@ "isasync": true, "name": "dedicateIpv4SubnetForZone", "params": [ - { - "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, @@ -144310,12 +145119,11 @@ "type": "uuid" }, { - "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" + "type": "string" }, { "description": "Id of the guest network IPv4 subnet", @@ -144324,28 +145132,31 @@ "related": "dedicateIpv4SubnetForZone", "required": true, "type": "uuid" + }, + { + "description": "domain ID of the account owning the IPv4 subnet", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the IPv4 subnet", - "name": "domain", + "description": "id of zone to which the IPv4 subnet belongs to.", + "name": "zoneid", "type": "string" }, { - "description": "date when this IPv4 subnet was created.", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the IPv4 subnet", - "name": "project", + "description": "name of zone to which the IPv4 subnet belongs to.", + "name": "zonename", "type": "string" }, { - "description": "the account of the IPv4 subnet", - "name": "account", + "description": "id of the guest IPv4 subnet", + "name": "id", "type": "string" }, { @@ -144354,83 +145165,49 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "guest IPv4 subnet", - "name": "subnet", + "description": "the account of the IPv4 subnet", + "name": "account", "type": "string" }, { - "description": "name of zone to which the IPv4 subnet belongs to.", - "name": "zonename", - "type": "string" + "description": "date when this IPv4 subnet was created.", + "name": "created", + "type": "date" }, { "description": "the domain ID of the IPv4 subnet", "name": "domainid", "type": "string" }, - {}, { - "description": "id of the guest IPv4 subnet", - "name": "id", + "description": "guest IPv4 subnet", + "name": "subnet", "type": "string" }, { - "description": "the project id of the IPv4 subnet", - "name": "projectid", + "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" - } - ], - "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": "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": "url", - "name": "url", + "description": "the project id of the IPv4 subnet", + "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 project name of the IPv4 subnet", + "name": "project", "type": "string" - } - ] + }, + {} + ], + "since": "4.20.0" }, { "description": "List Shared FileSystems", @@ -144438,33 +145215,24 @@ "name": "listSharedFileSystems", "params": [ { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, - { - "description": "the ID of the network", + "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": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the ID of the availability zone", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "tags", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "list only resources belonging to the domain specified", + "description": "the disk offering of the shared filesystem", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "diskofferingid", + "related": "", "required": false, "type": "uuid" }, @@ -144476,16 +145244,24 @@ "type": "integer" }, { - "description": "makes the API's response contains only the resource count", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "isrecursive", "required": false, "type": "boolean" }, { - "description": "List by keyword", + "description": "the service offering of the shared filesystem", "length": 255, - "name": "keyword", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", + "required": false, + "type": "uuid" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", "required": false, "type": "string" }, @@ -144504,69 +145280,75 @@ "type": "string" }, { - "description": "the disk offering of the shared filesystem", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the ID of the availability zone", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the ID of the shared filesystem", + "description": "List by keyword", "length": 255, - "name": "id", - "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", + "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": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "listall", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the service offering of the shared filesystem", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "retrieveonlyresourcecount", "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": "the ID of the network", "length": 255, - "name": "isrecursive", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the ID of the shared filesystem", "length": 255, - "name": "tags", + "name": "id", + "related": "listSharedFileSystems,changeSharedFileSystemDiskOffering", "required": false, - "type": "map" + "type": "uuid" } ], "related": "changeSharedFileSystemDiskOffering", "response": [ { - "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": "the shared filesystem provider", - "name": "provider", + "description": "name of the storage pool hosting the data volume", + "name": "storage", + "type": "string" + }, + { + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", "type": "string" }, { @@ -144575,14 +145357,23 @@ "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the filesystem format", + "name": "filesystem", "type": "string" }, - {}, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "the domain associated with the shared filesystem", + "name": "domain", + "type": "string" + }, + { + "description": "the project ID of the shared filesystem", + "name": "projectid", + "type": "string" + }, + { + "description": "the project name of the shared filesystem", + "name": "project", "type": "string" }, { @@ -144590,28 +145381,53 @@ "name": "nic", "response": [ { - "description": "the type of the nic", - "name": "type", + "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 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 broadcast uri of the nic", - "name": "broadcasturi", + "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", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the ID of the nic", + "name": "id", + "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" }, { @@ -144625,68 +145441,58 @@ "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the name of the corresponding network", + "name": "networkname", "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 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 isolation uri of the nic", + "name": "isolationuri", "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 name of the corresponding network", - "name": "networkname", + "description": "the type of the nic", + "name": "type", "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": "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "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": "the traffic type of the nic", - "name": "traffictype", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { @@ -144695,18 +145501,8 @@ "type": "string" }, { - "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": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -144715,111 +145511,66 @@ "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 netmask of the nic", - "name": "netmask", + "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 isolation uri of the nic", - "name": "isolationuri", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "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" } ], "type": "list" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "the bytes actually consumed on disk", - "name": "physicalsize", - "type": "long" - }, - { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", - "type": "string" - }, - { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", - "type": "string" - }, - { - "description": "ID of the storage fs vm", - "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" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "name of the storage fs data volume", + "name": "volumename", "type": "string" }, { - "description": "Network name of the shared filesystem", - "name": "networkname", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, { - "description": "the state of the shared filesystem", - "name": "state", + "description": "Name of the availability zone", + "name": "zonename", "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": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { - "description": "path of the domain to which the shared filesystem", - "name": "domainpath", + "description": "description of the shared filesystem", + "name": "description", "type": "string" }, { @@ -144828,59 +145579,43 @@ "type": "string" }, { - "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": "name of the storage fs data volume", - "name": "volumename", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "disk offering ID for the shared filesystem", - "name": "diskofferingid", + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Network name of the shared filesystem", + "name": "networkname", "type": "string" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", + "description": "ID of the storage fs data volume", + "name": "volumeid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", + "type": "long" }, - {}, { - "description": "description of the shared filesystem", - "name": "description", + "description": "ID of the storage fs vm", + "name": "vmstate", "type": "string" }, { - "description": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" - }, - { - "description": "provisioning type used in the shared filesystem", - "name": "provisioningtype", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { @@ -144889,18 +145624,18 @@ "type": "long" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", + "description": "the shared filesystem provider", + "name": "provider", "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": "Network ID of the shared filesystem", - "name": "networkid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -144908,8 +145643,8 @@ "name": "tags", "response": [ { - "description": "tag value", - "name": "value", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -144917,29 +145652,34 @@ "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": "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 id the tag belongs to", + "name": "projectid", "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -144947,87 +145687,163 @@ "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", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" } ], "type": "set" }, + {}, { - "description": "the filesystem format", - "name": "filesystem", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "type": "string" }, { - "description": "Name of the availability zone", - "name": "zonename", + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", "type": "string" }, { - "description": "the project ID of the shared filesystem", - "name": "projectid", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" + }, + { + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "the project name of the shared filesystem", - "name": "project", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the disk utilization", + "name": "utilization", "type": "string" }, + {}, { "description": "size of the shared filesystem", "name": "size", "type": "long" + }, + { + "description": "Network ID of the shared filesystem", + "name": "networkid", + "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "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": "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": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" + } + ] + }, { "description": "Updates a role", "isasync": false, "name": "updateRole", "params": [ { - "description": "Indicates whether the role will be visible to all users (public) or only to root admins (private).", + "description": "The description of the role", "length": 255, - "name": "ispublic", + "name": "description", "required": false, - "type": "boolean" + "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", + "name": "type", "required": false, "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).", "length": 255, - "name": "type", + "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" }, @@ -145050,8 +145866,20 @@ "related": "listRoles", "response": [ { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", + "type": "string" + }, + {}, + {}, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the type of the role", + "name": "type", "type": "string" }, { @@ -145069,28 +145897,16 @@ "name": "isdefault", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, { "description": "the state of the role", "name": "state", "type": "string" }, - {}, - { - "description": "the type of the role", - "name": "type", - "type": "string" - }, { - "description": "the name of the role", - "name": "name", + "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", @@ -145105,28 +145921,33 @@ "name": "listRemoteAccessVpns", "params": [ { - "description": "public ip address id of the vpn server", + "description": "List by keyword", "length": 255, - "name": "publicipid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "keyword", "required": false, - "type": "uuid" + "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": "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": "Lists remote access vpn rule with the specified 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": "listRemoteAccessVpns", + "name": "isrecursive", "required": false, - "since": "4.3", - "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.", @@ -145136,11 +145957,12 @@ "type": "boolean" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "Lists remote access vpn rule with the specified ID", "length": 255, - "name": "projectid", - "related": "", + "name": "id", + "related": "listRemoteAccessVpns", "required": false, + "since": "4.3", "type": "uuid" }, { @@ -145150,14 +145972,6 @@ "required": false, "type": "string" }, - { - "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, @@ -145166,10 +145980,10 @@ "type": "integer" }, { - "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": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -145183,52 +145997,62 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "keyword", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "public ip address id of the vpn server", "length": 255, - "name": "pagesize", + "name": "publicipid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, - "type": "integer" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", + "description": "the public ip address of the vpn server", + "name": "publicipid", "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": "is vpn for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "the id of the remote access vpn", - "name": "id", + "description": "path of the domain to which the remote access vpn belongs", + "name": "domainpath", "type": "string" }, { - "description": "the account of the remote access vpn", - "name": "account", + "description": "the id of the remote access vpn", + "name": "id", "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 domain id of the account of the remote access vpn", - "name": "domainid", + "description": "the public ip address of the vpn server", + "name": "publicip", "type": "string" }, { @@ -145237,13 +146061,13 @@ "type": "string" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { - "description": "the public ip address of the vpn server", - "name": "publicipid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { @@ -145251,14 +146075,11 @@ "name": "iprange", "type": "string" }, + {}, + {}, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -145267,14 +146088,9 @@ "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" } ] }, @@ -145293,27 +146109,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": "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" @@ -145333,28 +146149,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": "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" + } ] }, { @@ -145373,18 +146189,13 @@ ], "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": "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" }, {}, @@ -145393,6 +146204,11 @@ "name": "success", "type": "boolean" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, {} ] }, @@ -145402,42 +146218,35 @@ "name": "createServiceInstance", "params": [ { - "description": "The right (outside) network ID for the service instance", - "length": 255, - "name": "rightnetworkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": true, - "type": "uuid" - }, - { - "description": "The name of the service instance", + "description": "An optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "name", - "required": true, + "name": "account", + "required": false, "type": "string" }, { - "description": "Availability zone for the service instance", + "description": "The service offering ID that defines the resources consumed by the service appliance", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": true, "type": "uuid" }, { - "description": "The service offering ID that defines the resources consumed by the service appliance", + "description": "The right (outside) network ID for the service instance", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "rightnetworkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": true, "type": "uuid" }, { - "description": "An optional account for the virtual machine. Must be used with domainId.", + "description": "Availability zone for the service instance", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { "description": "An optional domainId for the virtual machine. If the account parameter is used, domainId must also be used.", @@ -145448,11 +146257,11 @@ "type": "uuid" }, { - "description": "Project ID for the service instance", + "description": "The template ID that specifies the image for the service appliance", "length": 255, - "name": "projectid", - "related": "", - "required": false, + "name": "templateid", + "related": "registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": true, "type": "uuid" }, { @@ -145464,29 +146273,26 @@ "type": "uuid" }, { - "description": "The template ID that specifies the image for the service appliance", + "description": "The name of the service instance", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "name", "required": true, + "type": "string" + }, + { + "description": "Project ID for the service instance", + "length": 255, + "name": "projectid", + "related": "", + "required": false, "type": "uuid" } ], "related": "", "response": [ { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - }, - { - "description": "the project name of the vm", - "name": "project", + "description": "the name of the virtual machine", + "name": "name", "type": "string" }, { @@ -145495,41 +146301,51 @@ "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 virtual machine", - "name": "name", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "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", - "type": "string" - }, { "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 project name of the vm", + "name": "project", "type": "string" }, { "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", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" } ] }, @@ -145550,108 +146366,113 @@ "related": "", "response": [ { - "description": "the template name for the system VM", - "name": "templatename", + "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 Zone name for the system VM", + "name": "zonename", "type": "string" }, { - "description": "guest vlan range", - "name": "guestvlan", + "description": "the hostname for the system VM", + "name": "hostname", "type": "string" }, { - "description": "public vlan range", - "name": "publicvlan", - "type": "list" + "description": "the number of active console sessions for the console proxy system vm", + "name": "activeviewersessions", + "type": "integer" }, { - "description": "the gateway for the system VM", - "name": "gateway", + "description": "the name of the service offering of the system virtual machine.", + "name": "serviceofferingname", "type": "string" }, { - "description": "the last disconnected date of host", - "name": "disconnected", - "type": "date" + "description": "the ID of the system VM", + "name": "id", + "type": "string" }, { - "description": "the state of the system VM", - "name": "state", + "description": "the Pod ID for the system VM", + "name": "podid", "type": "string" }, { - "description": "CPU arch of the system VM", - "name": "arch", + "description": "the link local IP address for the system vm", + "name": "linklocalip", "type": "string" }, { - "description": "the hostname for the system VM", - "name": "hostname", + "description": "the public MAC address for the system VM", + "name": "publicmacaddress", "type": "string" }, { - "description": "the public netmask for the system VM", - "name": "publicnetmask", + "description": "the public IP address for the system VM", + "name": "publicip", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the system VM", "name": "name", "type": "string" }, { - "description": "the public IP address for the system VM", - "name": "publicip", + "description": "the template name for the system VM", + "name": "templatename", "type": "string" }, { - "description": "the host ID for the system VM", - "name": "hostid", + "description": "the ID of the service offering of the system virtual machine.", + "name": "serviceofferingid", "type": "string" }, { - "description": "the agent state of the system VM", - "name": "agentstate", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "the link local netmask for the system vm", - "name": "linklocalnetmask", - "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": "guest vlan range", + "name": "guestvlan", + "type": "string" }, { - "description": "the ID of the system VM", - "name": "id", + "description": "the Pod name for the system VM", + "name": "podname", "type": "string" }, { - "description": "the Pod ID for the system VM", - "name": "podid", + "description": "the link local MAC address for the system vm", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the private MAC address for the system VM", - "name": "privatemacaddress", + "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 private MAC address for the system VM", + "name": "privatemacaddress", "type": "string" }, { - "description": "the Zone ID for the system VM", - "name": "zoneid", + "description": "the public netmask for the system VM", + "name": "publicnetmask", "type": "string" }, { @@ -145660,102 +146481,97 @@ "type": "string" }, { - "description": "the network domain for the system VM", - "name": "networkdomain", + "description": "the agent state of the system VM", + "name": "agentstate", "type": "string" }, { - "description": "the template ID for the system VM", - "name": "templateid", + "description": "the link local netmask for the system vm", + "name": "linklocalnetmask", "type": "string" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the system VM type", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the public MAC address for the system VM", - "name": "publicmacaddress", + "description": "the Zone ID for the system VM", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the name of the service offering of the system virtual machine.", - "name": "serviceofferingname", + "description": "the gateway for the system VM", + "name": "gateway", "type": "string" }, { - "description": "the Zone name for the system VM", - "name": "zonename", + "description": "the state of the system VM", + "name": "state", "type": "string" }, { - "description": "the ID of the service offering of the system virtual machine.", - "name": "serviceofferingid", + "description": "the private netmask for the system VM", + "name": "privatenetmask", "type": "string" }, { - "description": "the private IP address for the system VM", - "name": "privateip", + "description": "the template ID for the system VM", + "name": "templateid", "type": "string" }, { - "description": "the date and time the system VM was created", - "name": "created", + "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 private IP address for the system VM", + "name": "privateip", + "type": "string" }, { - "description": "the control state of the host for the system VM", - "name": "hostcontrolstate", + "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the first DNS for the system VM", - "name": "dns1", - "type": "string" + "description": "the date and time the system VM was created", + "name": "created", + "type": "date" }, { - "description": "the Pod name for the system VM", - "name": "podname", + "description": "the first DNS for the system VM", + "name": "dns1", "type": "string" }, { - "description": "the private netmask for the system VM", - "name": "privatenetmask", + "description": "the second DNS for the system VM", + "name": "dns2", "type": "string" }, + {}, { - "description": "the second DNS for the system VM", - "name": "dns2", + "description": "the system VM type", + "name": "systemvmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "public vlan range", + "name": "publicvlan", + "type": "list" }, { - "description": "the link local MAC address for the system vm", - "name": "linklocalmacaddress", + "description": "the network domain for the system VM", + "name": "networkdomain", "type": "string" - }, - {} + } ] }, { @@ -145764,164 +146580,119 @@ "name": "registerVnfTemplate", "params": [ { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", - "length": 255, - "name": "arch", - "required": false, - "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. ", - "length": 255, - "name": "zoneids", - "related": "listZones", - "required": false, - "type": "list" - }, - { - "description": "ID of the extension", + "description": "true if the template is available to all accounts; default is true", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "ispublic", "required": false, - "since": "4.21.0", - "type": "uuid" + "type": "boolean" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "account", + "name": "bits", "required": false, - "type": "string" + "type": "integer" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isfeatured", + "name": "isdynamicallyscalable", "required": false, "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": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "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 the template supports the sshkey upload feature; default is false", "length": 255, - "name": "checksum", + "name": "sshkeyenabled", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the ID of the zone the template is to be hosted on", + "description": "Register template for the project", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "forcks", + "name": "externaldetails", "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" + "type": "map" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "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": "isrouting", + "name": "checksum", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", + "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": "deployasis", + "name": "vnfnics", "required": false, - "since": "4.15.1", - "type": "boolean" + "type": "map" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "the target hypervisor for the template", "length": 255, - "name": "passwordenabled", - "required": false, - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "ispublic", + "name": "arch", "required": false, - "type": "boolean" + "since": "4.20", + "type": "string" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "sshkeyenabled", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "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": "externaldetails", + "name": "zoneids", + "related": "listZones", "required": false, - "since": "4.21.0", - "type": "map" + "type": "list" }, { - "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": "the URL of where the template is hosted. Possible URL include http:// and https://", + "length": 2048, + "name": "url", + "required": true, + "type": "string" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if this template is a featured template, false otherwise", "length": 255, - "name": "isdynamicallyscalable", + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "directdownload", + "name": "isrouting", "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", + "description": "the name of the template", "length": 255, - "name": "hypervisor", + "name": "name", "required": true, "type": "string" }, @@ -145933,55 +146704,47 @@ "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": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "ostypeid", - "related": "", + "name": "isextractable", "required": false, - "type": "uuid" + "type": "boolean" }, { - "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 tag for this template.", "length": 255, - "name": "vnfdetails", + "name": "templatetag", "required": false, - "type": "map" + "type": "string" }, { - "description": "true if this template requires HVM", + "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", "length": 255, - "name": "requireshvm", + "name": "deployasis", "required": false, + "since": "4.15.1", "type": "boolean" }, { - "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, - "since": "4.19.0", - "type": "string" - }, - { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "isextractable", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "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": "domainid", - "related": "listDomains", + "name": "vnfdetails", "required": false, - "type": "uuid" + "type": "map" }, { - "description": "Register template for the project", + "description": "the ID of the zone the template is to be hosted on", "length": 255, - "name": "projectid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, @@ -145993,131 +146756,71 @@ "type": "map" }, { - "description": "the name of the template", + "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": "name", - "required": true, - "type": "string" - } - ], - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "response": [ - { - "description": "the name of the secondary storage host for the template", - "name": "hostname", - "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": "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 project id of the template", - "name": "projectid", - "type": "string" + "name": "ostypeid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "the project name of the template", - "name": "project", + "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, + "since": "4.19.0", "type": "string" }, { - "description": "true if this template is a featured template, false otherwise", - "name": "isfeatured", + "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": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" - }, - { - "description": "the template name", - "name": "name", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", - "type": "string" + "description": "true if this template requires HVM", + "length": 255, + "name": "requireshvm", + "required": false, + "type": "boolean" }, - {}, { - "description": "the template ID", - "name": "id", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "ID of the extension", + "length": 255, + "name": "extensionid", + "related": "listExtensions", + "required": false, + "since": "4.21.0", + "type": "uuid" + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ + { + "description": "the status of the template", + "name": "status", "type": "string" }, { @@ -146126,44 +146829,54 @@ "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", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "true if the reset password feature is enabled, false otherwise", - "name": "passwordenabled", - "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", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "name": "isdynamicallyscalable", "type": "boolean" }, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, { - "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", - "name": "isdynamicallyscalable", + "description": "the name of userdata linked to this template", + "name": "userdataname", + "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", + "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": "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": "if root disk template, then ids of the datas disk templates this template owns", - "name": "childtemplates", - "type": "set" + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "the URL which the template/iso is registered from", @@ -146171,24 +146884,29 @@ "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the type of the template", + "name": "templatetype", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", - "type": "string" + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" }, { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", + "type": "boolean" }, { "description": "additional key/value details tied with template", @@ -146196,39 +146914,59 @@ "type": "map" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", + "type": "boolean" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "Lists the download progress of a template across all secondary storages", + "name": "downloaddetails", + "type": "list" + }, + { + "description": "the tag of this template", + "name": "templatetag", "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": "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": "the physical size of the template", - "name": "physicalsize", - "type": "long" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "the id of userdata linked to this template", + "name": "userdataid", + "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 ID of extension linked to this template", - "name": "extensionid", + "description": "the template ID", + "name": "id", "type": "string" }, { - "description": "the account id to which the template belongs", - "name": "accountid", + "description": "the template name", + "name": "name", "type": "string" }, { @@ -146237,8 +146975,24 @@ "type": "long" }, { - "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 hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + {}, + { + "description": "The name of extension linked to this template", + "name": "extensionname", + "type": "string" + }, + { + "description": "the project name of the template", + "name": "project", "type": "string" }, { @@ -146247,38 +147001,120 @@ "type": "string" }, { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", + "description": "the project id of the template", + "name": "projectid", + "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", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "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": "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "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 name of the zone for this template", + "name": "zonename", + "type": "string" + }, + { + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, + { + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", + "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 template display text", + "name": "displaytext", "type": "string" }, { - "description": "the date this template was created", - "name": "created", + "description": "the date this template was removed", + "name": "removed", "type": "date" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the name of the secondary storage host for the template", + "name": "hostname", "type": "string" }, { @@ -146287,76 +147123,56 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", - "type": "string" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, { - "description": "the type of the template", - "name": "templatetype", + "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 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 status of the template", - "name": "status", + "description": "the name of the domain to which the template belongs", + "name": "domain", "type": "string" }, - { - "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", - "type": "boolean" - }, { "description": "CPU Arch of the template", "name": "arch", "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 OS type for this template.", - "name": "ostypename", + "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", + "description": "the account id to which the template belongs", + "name": "accountid", "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": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the account name to which the template belongs", + "name": "account", + "type": "string" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" - } + }, + {} ], "since": "4.19.0" }, @@ -146366,31 +147182,24 @@ "name": "listVirtualMachinesUsageHistory", "params": [ { - "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": false, - "type": "uuid" - }, - { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "List by keyword", "length": 255, - "name": "enddate", + "name": "keyword", "required": false, - "type": "date" + "type": "string" }, { - "description": "", + "description": "the ID of the virtual machine.", "length": 255, - "name": "pagesize", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "List by keyword", + "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": "keyword", + "name": "name", "required": false, "type": "string" }, @@ -146398,7 +147207,7 @@ "description": "the IDs of the virtual machines, mutually exclusive with id.", "length": 255, "name": "ids", - "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", + "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,createVMFromBackup,importVm", "required": false, "type": "list" }, @@ -146410,39 +147219,39 @@ "type": "date" }, { - "description": "name of the virtual machine (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "length": 255, + "name": "enddate", + "required": false, + "type": "date" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "listSystemVmsUsageHistory", "response": [ - {}, { - "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 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": "user generated name. The name of the virtual machine is returned if no displayname exists.", "name": "displayname", @@ -146451,13 +147260,92 @@ { "description": "the list of VM stats", "name": "stats", + "response": [ + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskioread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the time when the VM stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", + "name": "timestamp", + "type": "date" + }, + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + } + ], "type": "list" }, { - "description": "the ID of the virtual machine", - "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" + }, + {} ], "since": "4.17" }, @@ -146478,111 +147366,180 @@ "related": "reconnectHost", "response": [ { - "description": "the host version", - "name": "version", + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "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": "the amount of the host's CPU currently allocated in MHz", + "name": "cpuallocatedvalue", + "type": "long" + }, + { + "description": "the host version", + "name": "version", + "type": "string" }, { "description": "the name of the host", "name": "name", "type": "string" }, + { + "description": "the ID of the host", + "name": "id", + "type": "string" + }, + { + "description": "the admin that annotated this host", + "name": "username", + "type": "string" + }, + { + "description": "Host details in key/value pairs.", + "name": "details", + "type": "map" + }, { "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 amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the amount of the host's memory currently allocated in bytes", + "name": "memoryallocatedbytes", "type": "long" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "the date and time the host was last pinged", + "name": "lastpinged", + "type": "date" + }, + { + "description": "the cluster type of the cluster that host belongs to", + "name": "clustertype", + "type": "string" + }, + { + "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", + "name": "hahost", + "type": "boolean" + }, + { + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the OS category ID of the host", + "name": "oscategoryid", "type": "string" }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the state of the host", + "name": "state", + "type": "status" + }, { "description": "the amount of the host's CPU currently allocated", "name": "cpuallocated", "type": "string" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "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 CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "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", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "the management server ID of the host", + "name": "managementserverid", "type": "string" }, { - "description": "the admin that annotated this host", - "name": "username", + "description": "the host out-of-band management information", + "name": "outofbandmanagement", + "type": "outofbandmanagementresponse" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "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 host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "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": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", + "type": "string" }, { - "description": "the IP address of the host", - "name": "ipaddress", - "type": "string" + "description": "the CPU number of the host", + "name": "cpunumber", + "type": "integer" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", - "type": "string" + "description": "true if the host has capability to support UEFI boot", + "name": "ueficapability", + "type": "boolean" }, { - "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 amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, - {}, + { + "description": "the host type", + "name": "type", + "type": "type" + }, { "description": "the Pod ID of the host", "name": "podid", @@ -146592,14 +147549,19 @@ "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": "Model Name of vGPU", + "name": "vgputype", + "type": "string" }, { "description": "Maximum Y resolution per display", @@ -146607,8 +147569,8 @@ "type": "long" }, { - "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" }, { @@ -146617,18 +147579,18 @@ "type": "long" }, { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" + "description": "Maximum no. of vgpu per gpu card (pgpu)", + "name": "maxvgpuperpgpu", + "type": "long" }, { - "description": "Maximum X resolution per display", - "name": "maxresolutionx", + "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", + "description": "Maximum X resolution per display", + "name": "maxresolutionx", "type": "long" }, { @@ -146638,49 +147600,30 @@ } ], "type": "list" - }, - { - "description": "GPU cards present in the host", - "name": "gpugroupname", - "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", - "type": "string" - }, - { - "description": "comma-separated list of implicit host tags for the host", - "name": "implicithosttags", - "type": "string" - }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", + "type": "boolean" }, + {}, { - "description": "CPU Arch of the host", - "name": "arch", - "type": "string" + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" }, { - "description": "capabilities of the host", - "name": "capabilities", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "true if the host is Ha host (dedicated to vms started by HA process; false otherwise", - "name": "hahost", - "type": "boolean" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" }, { "description": "Total GPUs on the Host", @@ -146688,9 +147631,9 @@ "type": "long" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" }, { "description": "comma-separated list of explicit host tags for the host", @@ -146698,94 +147641,53 @@ "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", - "type": "string" - }, - { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "the IP address of the host", + "name": "ipaddress", "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - {}, - { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "type": "integer" - }, - { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" - }, - { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" - }, - { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "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": "the host type", - "name": "type", - "type": "type" - }, - { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "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", + "description": "the OS category name of the host", + "name": "oscategoryname", "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", + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", + "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 management server ID of the host", - "name": "managementserverid", - "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 last pinged", - "name": "lastpinged", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", + "name": "virtualmachineid", "type": "string" }, { @@ -146794,129 +147696,115 @@ "type": "string" }, { - "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" - }, - { - "description": "the last annotation set on this host by an admin", - "name": "annotation", + "description": "the hypervisor version", + "name": "hypervisorversion", "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "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", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the ID of the host", - "name": "id", + "description": "events available for the host", + "name": "events", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", + "description": "the date and time the host was created", + "name": "created", "type": "date" }, + {}, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" - }, - { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", + "description": "the CPU speed of the host", + "name": "cpuspeed", "type": "long" }, { - "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": "the Zone ID of the host", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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 total disk size of the host", - "name": "disksizetotal", - "type": "long" + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", - "type": "string" + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" }, { - "description": "the Pod name of the host", - "name": "podname", + "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 host hypervisor", + "name": "hypervisor", "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": "comma-separated list of storage access groups on the cluster", + "name": "clusterstorageaccessgroups", + "type": "string" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", "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 in bytes", - "name": "memoryallocatedbytes", - "type": "long" + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" }, { - "description": "events available for the host", - "name": "events", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the host", + "name": "podname", "type": "string" } ], @@ -146928,32 +147816,27 @@ "name": "createKubernetesCluster", "params": [ { - "description": "name for the Kubernetes cluster", - "length": 255, - "name": "name", - "required": true, - "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": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", + "description": "password for the docker image private registry", "length": 255, - "name": "masternodes", + "name": "dockerregistrypassword", "required": false, - "type": "long" + "type": "string" }, { - "description": "user name for the docker image private registry", + "description": "Network in which Kubernetes cluster is to be launched", "length": 255, - "name": "dockerregistryusername", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { "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", @@ -146964,11 +147847,11 @@ "type": "long" }, { - "description": "availability zone in which Kubernetes cluster to be launched", + "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": "zoneid", - "related": "listZones", - "required": true, + "name": "domainid", + "related": "listDomains", + "required": false, "type": "uuid" }, { @@ -146981,91 +147864,76 @@ "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", + "description": "the ID of the service offering for the virtual machines in the cluster.", "length": 255, - "name": "kubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, "type": "uuid" }, { - "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", + "description": "number of Kubernetes cluster control nodes, default is 1", "length": 255, - "name": "cniconfigdetails", + "name": "controlnodes", "required": false, - "since": "4.21.0", - "type": "map" + "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" }, { - "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 worker nodes", + "description": "(Optional) Node Type to Template ID mapping. If provided, it overrides the default template: System VM template", "length": 255, - "name": "size", + "name": "nodetemplates", "required": false, - "type": "long" + "since": "4.21.0", + "type": "map" }, { - "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", + "description": "Deploy cluster for the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "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", + "description": "name for the Kubernetes cluster", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "required": false, - "type": "uuid" + "name": "name", + "required": true, + "type": "string" }, { - "description": "number of Kubernetes cluster control nodes, default is 1", + "description": "user name for the docker image private registry", "length": 255, - "name": "controlnodes", + "name": "dockerregistryusername", "required": false, - "type": "long" + "type": "string" }, { - "description": "name of the ssh key pair used to login to the virtual machines", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "keypair", + "name": "account", "required": false, "type": "string" }, { - "description": "description for the Kubernetes cluster", + "description": "external load balancer IP address while using shared network with Kubernetes HA cluster", "length": 255, - "name": "description", + "name": "externalloadbalanceripaddress", "required": false, "type": "string" }, @@ -147078,82 +147946,120 @@ "type": "string" }, { - "description": "(Optional) Node Type to Service Offering ID mapping. If provided, it overrides the serviceofferingid parameter", + "description": "URL for the docker image private registry", "length": 255, - "name": "nodeofferings", + "name": "dockerregistryurl", + "required": false, + "type": "string" + }, + { + "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": "cniconfigdetails", "required": false, "since": "4.21.0", "type": "map" }, { - "description": "Deploy cluster for the project", + "description": "Kubernetes version with which cluster to be launched", "length": 255, - "name": "projectid", - "related": "", + "name": "kubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, "type": "uuid" }, { - "description": "password for the docker image private registry", + "description": "root disk size in GB for each node", "length": 255, - "name": "dockerregistrypassword", + "name": "noderootdisksize", "required": false, - "type": "string" + "type": "long" }, { - "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.", + "description": "description for the Kubernetes cluster", "length": 255, - "name": "hypervisor", + "name": "description", "required": false, - "since": "4.21.0", "type": "string" }, { - "description": "the ID of the service offering for the virtual machines in the cluster.", + "description": "if true, setups up CloudStack CSI driver", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "enablecsi", "required": false, - "type": "uuid" + "since": "4.22.0", + "type": "boolean" }, { - "description": "URL for the docker image private registry", + "description": "number of Kubernetes cluster master nodes, default is 1. This option is deprecated, please use 'controlnodes' parameter.", "length": 255, - "name": "dockerregistryurl", + "name": "masternodes", "required": false, - "type": "string" + "type": "long" + }, + { + "description": "the AS Number of the network", + "length": 255, + "name": "asnumber", + "required": false, + "type": "long" + }, + { + "description": "number of Kubernetes cluster worker nodes", + "length": 255, + "name": "size", + "required": false, + "type": "long" + }, + { + "description": "availability zone in which Kubernetes cluster to be launched", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" } ], "related": "startKubernetesCluster", "response": [ { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the project name of the Kubernetes cluster", + "name": "project", "type": "string" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" + }, + { + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", + "type": "long" + }, + { + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { @@ -147162,8 +148068,8 @@ "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", + "description": "the description of the Kubernetes cluster", + "name": "description", "type": "string" }, { @@ -147172,65 +148078,64 @@ "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "path of the domain to which the Kubernetes cluster belongs", + "name": "domainpath", "type": "string" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", + "type": "string" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", + "type": "long" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the list of virtualmachine associated with this Kubernetes cluster", + "name": "virtualmachines", + "type": "list" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { - "description": "the ID of the network of the Kubernetes cluster", - "name": "networkid", - "type": "string" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { "description": "the name of the domain in which the Kubernetes cluster exists", "name": "domain", "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 memory the Kubernetes cluster", "name": "memory", "type": "string" }, - {}, { - "description": "the list of virtualmachine associated with this Kubernetes cluster", - "name": "virtualmachines", - "type": "list" + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" }, { - "description": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", + "type": "string" + }, + { + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", + "type": "string" }, { "description": "the size (worker nodes count) of the Kubernetes cluster", @@ -147238,63 +148143,69 @@ "type": "long" }, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", - "type": "string" + "description": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" + }, + { + "description": "Public IP Address of the cluster", + "name": "ipaddress", "type": "string" }, { - "description": "the name of the Kubernetes cluster", - "name": "name", + "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": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "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 Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingid", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", + "type": "string" }, + {}, { - "description": "the date when this Kubernetes cluster was created", - "name": "created", - "type": "date" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "keypair details", + "name": "keypair", "type": "string" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -147303,70 +148214,65 @@ "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zoneid", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the name of the Kubernetes cluster", + "name": "name", "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", "type": "string" }, { - "description": "the name of the network of the Kubernetes cluster", - "name": "associatednetworkname", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the id of the Kubernetes cluster", + "name": "id", + "type": "string" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the project id of the Kubernetes cluster", + "name": "projectid", "type": "string" }, { - "description": "the control nodes count for the Kubernetes cluster", - "name": "controlnodes", - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "Minimum size of the cluster", + "name": "minsize", + "type": "long" }, {}, { - "description": "keypair details", - "name": "keypair", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the name of the service offering of the control nodes on the Kubernetes cluster", + "name": "controlofferingname", "type": "string" }, { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" + "description": "the control nodes count for the Kubernetes cluster", + "name": "controlnodes", + "type": "long" } ] }, @@ -147376,18 +148282,20 @@ "name": "listStorageNetworkIpRange", "params": [ { - "description": "List by keyword", + "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", "length": 255, - "name": "keyword", + "name": "id", + "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "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": "page", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "optional parameter. Pod uuid, if specicied and range uuid is absent, using it to search the range.", @@ -147398,52 +148306,49 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "optional parameter. Zone uuid, if specicied and both pod uuid and range uuid are absent, using it to search the range.", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "optional parameter. Storaget network IP range uuid, if specicied, using it to search the range.", + "description": "", "length": 255, - "name": "id", - "related": "createStorageNetworkIpRange,listStorageNetworkIpRange", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "createStorageNetworkIpRange", "response": [ { - "description": "the network uuid of storage network IP range", - "name": "networkid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" }, - {}, { "description": "the Pod uuid for the storage network IP range", "name": "podid", "type": "string" }, { - "description": "the uuid of storage network IP range.", - "name": "id", + "description": "the Zone uuid of the storage network IP range", + "name": "zoneid", "type": "string" }, + { + "description": "the ID or VID of the VLAN.", + "name": "vlan", + "type": "integer" + }, {}, { "description": "the start ip of the storage network IP range", @@ -147451,34 +148356,35 @@ "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", - "type": "integer" + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" }, { - "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 uuid of storage network IP range.", + "name": "id", "type": "string" }, { - "description": "the Zone uuid of the storage network IP range", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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 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", + "type": "string" } ], "since": "3.0.0" @@ -147489,58 +148395,52 @@ "name": "configureVirtualRouterElement", "params": [ { - "description": "the ID of the virtual router provider", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "id", - "related": "configureVirtualRouterElement", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", + "description": "the ID of the virtual router provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureVirtualRouterElement", "required": true, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ - {}, - {}, - { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" - }, { "description": "the project name of the address", "name": "project", "type": "string" }, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the domain associated with the provider", + "name": "domain", "type": "string" }, + {}, { - "description": "path of the domain to which the provider belongs", - "name": "domainpath", + "description": "the domain ID associated with the provider", + "name": "domainid", "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", + "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" }, { @@ -147549,19 +148449,25 @@ "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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 id of the router", + "name": "id", "type": "string" + }, + { + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" } ] }, @@ -147581,42 +148487,42 @@ ], "related": "disableHAForHost", "response": [ - {}, { - "description": "the host HA provider", - "name": "haprovider", - "type": "string" + "description": "the HA state of the host", + "name": "hastate", + "type": "hastate" }, { - "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": "if host HA is enabled for the host", "name": "haenable", "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 HA state of the host", - "name": "hastate", - "type": "hastate" + "description": "the ID of the host", + "name": "hostid", + "type": "string" + }, + { + "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" } ], "since": "4.11" @@ -147626,706 +148532,243 @@ "isasync": true, "name": "updateVMAffinityGroup", "params": [ - { - "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, - "name": "affinitygroupnames", - "related": "", - "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, - "name": "affinitygroupids", - "related": "", - "required": false, - "type": "list" - } - ], - "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": "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": "the read (IO) of disk on the VM", - "name": "diskioread", - "type": "long" - }, - { - "description": "the list of nics associated with vm", - "name": "nic", - "response": [ - { - "description": "the netmask of the nic", - "name": "netmask", - "type": "string" - }, - { - "description": "the gateway of the nic", - "name": "gateway", - "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 ID of the nic", - "name": "id", - "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 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": "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 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": "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": "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 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": "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" - }, - { - "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": "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 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 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": "tag key name", - "name": "key", - "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": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", - "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 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", - "name": "securitygroupname", - "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 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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "the project name where tag belongs to", - "name": "project", - "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": "the account associated with the tag", - "name": "account", - "type": "string" - }, - { - "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 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 list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" - } - ], - "type": "set" + "length": 255, + "name": "affinitygroupids", + "related": "", + "required": false, + "type": "list" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", + "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, + "name": "affinitygroupnames", + "related": "", + "required": false, + "type": "list" + }, + { + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + } + ], + "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,createVMFromBackup,importVm", + "response": [ + { + "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 vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "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": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "OS type id of the vm", + "name": "ostypeid", + "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { - "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 ID of the host for the virtual machine", - "name": "hostid", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", "type": "long" }, { - "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 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 vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "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 type of the template for the virtual machine", + "name": "templatetype", + "type": "string" }, { - "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", + "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "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": "the date when this virtual machine was created", + "name": "created", + "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", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "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 ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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 amount of the vm's CPU currently used", - "name": "cpuused", + "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": "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": "customer associated with the tag", + "name": "customer", + "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": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the group name of the virtual machine", - "name": "group", + "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" }, { @@ -148334,64 +148777,104 @@ "type": "boolean" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "User VM type", + "name": "vmtype", "type": "string" }, { - "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": "the maximum X resolution", - "name": "maxresolutionx", + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" + }, + { + "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 maximum number of display heads", - "name": "maxheads", + "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 VM's primary IP address", - "name": "ipaddress", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, + { + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, { "description": "the ID of the backup offering of the virtual machine", "name": "backupofferingid", "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": "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": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "public IP address id associated with vm 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": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { "description": "Guest vm Boot Mode", @@ -148399,191 +148882,380 @@ "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "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 count of GPUs on the virtual machine", - "name": "gpucount", + "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", + "description": "device type of the root volume", + "name": "rootdevicetype", "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "type": "long" + }, + { + "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", "type": "string" }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the ID of the virtual machine", + "name": "id", + "type": "string" + }, + { + "description": "the list of nics associated with vm", + "name": "nic", "response": [ { - "description": "tag key name", - "name": "key", + "description": "device id for the network when plugged into the virtual machine", + "name": "deviceid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "the ip address of the nic", + "name": "ipaddress", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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": "the account associated with the tag", - "name": "account", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 resource", - "name": "resourceid", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "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": "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": "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "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": "the ID of the nic", + "name": "id", + "type": "string" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "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", + "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" } ], "type": "set" }, + {}, { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "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 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", - "name": "networkkbsread", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, + {}, { - "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": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "type": "string" }, { - "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", - "name": "memoryintfreekbs", + "description": "the VM's disk read in KiB", + "name": "diskkbsread", "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" - }, - { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "User VM type", - "name": "vmtype", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "OS name of the vm", - "name": "osdisplayname", + "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 maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "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", + "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", "type": "long" }, { - "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": "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": "path of the Domain the affinity group belongs to", + "name": "domainpath", + "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 description of the affinity group", + "name": "description", + "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 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": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", + "type": "list" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { "description": "true if the entity/resource has annotations", @@ -148591,9 +149263,9 @@ "type": "boolean" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" }, { "description": "Guest vm Boot Type", @@ -148601,162 +149273,402 @@ "type": "string" }, { - "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 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 group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "type": "boolean" - }, - { - "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 ID of the affinity group", - "name": "id", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the name of the affinity group", - "name": "name", - "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": "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 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 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" + } + ], + "type": "set" }, { - "description": "the account owning the affinity group", + "description": "the account owning the security group", "name": "account", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "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 type of the affinity group", - "name": "type", + "description": "the project id of the group", + "name": "projectid", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "path of the Domain the security group belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "path of the Domain the affinity group belongs to", - "name": "domainpath", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "the project name of the affinity group", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the domain name of the affinity 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", + "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 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 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 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": "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 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" + } + ], + "type": "set" + }, + { + "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" + } + ], + "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": "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": "security group name", + "name": "securitygroupname", + "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 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 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" + }, + { + "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": "id of the resource", + "name": "resourceid", + "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 key name", + "name": "key", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "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", - "name": "keypairs", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "type": "string" + "description": "Instance lease duration in days", + "name": "leaseduration", + "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": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, {}, { - "description": "Base64 string containing the user data", - "name": "userdata", - "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 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": "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 virtual machine", @@ -148764,24 +149676,19 @@ "type": "string" }, { - "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", + "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", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", - "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.", @@ -148789,25 +149696,24 @@ "type": "boolean" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "type": "long" + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, { "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" } ] }, @@ -148817,16 +149723,16 @@ "name": "registerNetscalerServicePackage", "params": [ { - "description": "Description of Service Package", + "description": "Name of the service Package.", "length": 255, - "name": "description", + "name": "name", "required": true, "type": "string" }, { - "description": "Name of the service Package.", + "description": "Description of Service Package", "length": 255, - "name": "name", + "name": "description", "required": true, "type": "string" } @@ -148834,8 +149740,8 @@ "related": "listRegisteredServicePackages", "response": [ { - "description": "Service Package Name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -148843,22 +149749,22 @@ "name": "id", "type": "string" }, + {}, + {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Service Package Name", + "name": "name", + "type": "string" }, { "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -148868,24 +149774,23 @@ "name": "updateWebhook", "params": [ { - "description": "Description for the Webhook", + "description": "State of the Webhook", "length": 255, - "name": "description", + "name": "state", "required": false, "type": "string" }, { - "description": "The ID of the Webhook", + "description": "Payload URL of the Webhook", "length": 255, - "name": "id", - "related": "createWebhook", - "required": true, - "type": "uuid" + "name": "payloadurl", + "required": false, + "type": "string" }, { - "description": "State of the Webhook", + "description": "Name for the Webhook", "length": 255, - "name": "state", + "name": "name", "required": false, "type": "string" }, @@ -148897,25 +149802,26 @@ "type": "string" }, { - "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", + "description": "Secret key of the Webhook", "length": 255, - "name": "name", + "name": "secretkey", "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": "If set to true then SSL verification will be done for the Webhook otherwise not", @@ -148926,23 +149832,23 @@ } ], "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": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + }, + {}, { "description": "true if operation is executed successfully", "name": "success", @@ -148964,20 +149870,6 @@ "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, - "name": "quota_enforce", - "required": false, - "type": "boolean" - }, { "description": "Value of the credits to be added+, subtracted-", "length": 255, @@ -148991,47 +149883,61 @@ "name": "account", "required": true, "type": "string" + }, + { + "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, + "name": "quota_enforce", + "required": false, + "type": "boolean" } ], "related": "", "response": [ - {}, { - "description": "The credit deposited.", - "name": "credit", - "type": "bigdecimal" + "description": "When the credit was added.", + "name": "creditedon", + "type": "date" }, { - "description": "Credit's currency.", - "name": "currency", + "description": "ID of the creditor user.", + "name": "creditoruserid", "type": "string" }, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "ID of the creditor user.", - "name": "creditoruserid", + "description": "Username of the creditor user.", + "name": "creditorusername", "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", + "description": "Credit's currency.", + "name": "currency", "type": "string" - } + }, + { + "description": "The credit deposited.", + "name": "credit", + "type": "bigdecimal" + }, + {}, + {} ], "since": "4.7.0" }, @@ -149040,17 +149946,25 @@ "isasync": false, "name": "discoverGpuDevices", "params": [ + { + "description": "ID of the host", + "length": 255, + "name": "id", + "related": "reconnectHost", + "required": true, + "type": "uuid" + }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -149060,36 +149974,35 @@ "name": "keyword", "required": false, "type": "string" - }, - { - "description": "ID of the host", - "length": 255, - "name": "id", - "related": "reconnectHost", - "required": true, - "type": "uuid" } ], "related": "listGpuDevices", "response": [ { "description": "the vGPU profile name assigned to this GPU device", - "name": "state", - "type": "state" + "name": "vgpuprofilename", + "type": "string" }, + {}, { "description": "the vGPU profile ID assigned to this GPU device", "name": "virtualmachineid", "type": "string" }, + {}, { - "description": "the ID of the GPU device", - "name": "id", + "description": "the GPU card ID associated with this GPU device", + "name": "gpucardid", "type": "string" }, { - "description": "bus address of the GPU device or MDEV UUID for vGPU devices", - "name": "busaddress", + "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": "virtualmachinename", "type": "string" }, { @@ -149098,71 +150011,64 @@ "type": "integer" }, { - "description": "the host name where the GPU device is attached", - "name": "hostname", + "description": "bus address of the GPU device or MDEV UUID for vGPU devices", + "name": "busaddress", "type": "string" }, { - "description": "the GPU card name associated with this GPU device", - "name": "gpucardname", + "description": "the host name where the GPU device is attached", + "name": "hostname", "type": "string" }, { "description": "the vGPU profile name assigned to this GPU device", - "name": "vgpuprofilename", - "type": "string" + "name": "state", + "type": "state" }, { - "description": "the host ID where the GPU device is attached", - "name": "hostid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - {}, - {}, { - "description": "the vGPU profile name assigned to this GPU device", - "name": "virtualmachinename", - "type": "string" + "description": "the state of the virtual machine to which this GPU device is allocated", + "name": "vmstate", + "type": "state" }, { - "description": "the vGPU profile ID assigned to this GPU device", - "name": "vgpuprofileid", + "description": "the ID of the parent GPU device, if this is a vGPU", + "name": "parentgpudeviceid", "type": "string" }, { - "description": "the NUMA node where the GPU device is located", - "name": "numanode", + "description": "the host ID where the GPU device is attached", + "name": "hostid", "type": "string" }, { - "description": "the GPU card ID associated with this GPU device", - "name": "gpucardid", - "type": "string" + "description": "the managed state of the GPU device (Enabled/Disabled)", + "name": "managedstate", + "type": "managedstate" }, { - "description": "the ID of the parent GPU device, if this is a vGPU", - "name": "parentgpudeviceid", + "description": "the NUMA node where the GPU device is located", + "name": "numanode", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the GPU device", + "name": "id", "type": "string" }, { - "description": "the state of the virtual machine to which this GPU device is allocated", - "name": "vmstate", - "type": "state" + "description": "the vGPU profile ID assigned to this GPU device", + "name": "vgpuprofileid", + "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.21.0" @@ -149182,31 +150088,31 @@ ], "related": "", "response": [ - { - "description": "The client certificate", - "name": "certificate", - "type": "string" - }, { "description": "The CA certificate(s)", "name": "cacertificates", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, + {}, + { + "description": "Private key for the certificate", + "name": "privatekey", + "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", + "description": "The client certificate", + "name": "certificate", "type": "string" } ], @@ -149236,16 +150142,24 @@ ], "related": "", "response": [ - {}, { - "description": "indicates if the certificate has been revoked from the host, failed or skipped", - "name": "status", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "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" }, { @@ -149253,29 +150167,55 @@ "name": "hostname", "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" }, + {} + ], + "since": "4.17.0" + }, + { + "description": "SAML Global Log Out API", + "isasync": false, + "name": "samlSlo", + "params": [], + "related": "", + "response": [ { - "description": "indicates the details in case of failure or host skipped", - "name": "details", + "description": "Response description", + "name": "description", "type": "string" }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" - } - ], - "since": "4.17.0" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + {}, + {} + ] }, { "description": "Creates a Project role", "isasync": false, "name": "updateProjectRole", "params": [ + { + "description": "ID of project where role is being created", + "length": 255, + "name": "projectid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "ID of the Project role", "length": 255, @@ -149285,65 +150225,57 @@ "type": "uuid" }, { - "description": "creates a project role with this unique name", + "description": "The description of the Project role", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" }, { - "description": "ID of project where role is being created", - "length": 255, - "name": "projectid", - "related": "", - "required": true, - "type": "uuid" - }, - { - "description": "The description of the Project role", + "description": "creates a project role with this unique name", "length": 255, - "name": "description", + "name": "name", "required": false, "type": "string" } ], "related": "", "response": [ - {}, + { + "description": "the id of the project", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the role", "name": "id", "type": "string" }, { - "description": "the description of the role", - "name": "description", + "description": "the name of the role", + "name": "name", "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", + "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 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 name of the role", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, {} ], @@ -149354,13 +150286,6 @@ "isasync": false, "name": "addLdapConfiguration", "params": [ - { - "description": "Hostname", - "length": 255, - "name": "hostname", - "required": true, - "type": "string" - }, { "description": "linked domain", "length": 255, @@ -149369,6 +150294,13 @@ "required": false, "type": "uuid" }, + { + "description": "Hostname", + "length": 255, + "name": "hostname", + "required": true, + "type": "string" + }, { "description": "Port", "length": 255, @@ -149380,34 +150312,216 @@ "related": "", "response": [ { - "description": "port the ldap server is running on", - "name": "port", - "type": "int" + "description": "linked domain", + "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": "name of the host running the ldap server", "name": "hostname", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the ID of the LDAP configuration", + "name": "id", + "type": "string" + }, + { + "description": "port the ldap server is running on", + "name": "port", + "type": "int" + }, + {} + ], + "since": "4.2.0" + }, + { + "description": "List running import virtual machine tasks from a unmanaged hosts into CloudStack", + "isasync": false, + "name": "listImportVmTasks", + "params": [ + { + "description": "Conversion host of the importing task", + "length": 255, + "name": "convertinstancehostid", + "related": "reconnectHost", + "required": false, + "type": "uuid" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "Filter tasks by state, valid options are: All, Running, Completed, Failed", + "length": 255, + "name": "tasksfilter", + "required": false, + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "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": "the ID of the Account", + "length": 255, + "name": "accountid", + "related": "enableAccount,listAccounts", + "required": false, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "the total task duration", + "name": "duration", + "type": "string" + }, + {}, + { + "description": "the last updated date of the importing task", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the duration of the current step", + "name": "stepduration", + "type": "string" + }, + { + "description": "the create date of the importing task", + "name": "created", + "type": "date" + }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + { + "description": "the current step on the importing VM task", + "name": "step", + "type": "string" + }, + { + "description": "the name of the host on which the instance is being converted", + "name": "convertinstancehostname", + "type": "string" + }, + { + "description": "the Zone ID", + "name": "zoneid", + "type": "string" + }, + { + "description": "the state of the importing VM task", + "name": "state", + "type": "string" + }, {}, { - "description": "linked domain", - "name": "domainid", + "description": "the display name of the importing VM", + "name": "displayname", + "type": "string" + }, + { + "description": "the datacenter name of the importing VM task", + "name": "datacentername", + "type": "string" + }, + { + "description": "the ID of account", + "name": "accountid", + "type": "string" + }, + { + "description": "the account name", + "name": "account", + "type": "string" + }, + { + "description": "the ID of the host on which the instance is being converted", + "name": "convertinstancehostid", + "type": "string" + }, + { + "description": "the ID of the imported VM (after task is completed)", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the vcenter name of the importing VM task", + "name": "vcenter", + "type": "string" + }, + { + "description": "the Zone name", + "name": "zonename", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the ID of importing task", + "name": "id", + "type": "string" + }, + { + "description": "the source VM name", + "name": "sourcevmname", + "type": "string" + }, + { + "description": "the current step description on the importing VM task", + "name": "description", "type": "string" } ], - "since": "4.2.0" + "since": "4.22" }, { "description": "create Tungsten-Fabric address group", @@ -149415,11 +150529,11 @@ "name": "createTungstenFabricAddressGroup", "params": [ { - "description": "Tungsten-Fabric ip prefix", + "description": "Tungsten-Fabric ip prefix length", "length": 255, - "name": "ipprefix", + "name": "ipprefixlen", "required": true, - "type": "string" + "type": "integer" }, { "description": "Tungsten-Fabric address group name", @@ -149437,36 +150551,36 @@ "type": "uuid" }, { - "description": "Tungsten-Fabric ip prefix length", + "description": "Tungsten-Fabric ip prefix", "length": 255, - "name": "ipprefixlen", + "name": "ipprefix", "required": true, - "type": "integer" + "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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 address group name", + "name": "name", + "type": "string" }, {}, + {}, { - "description": "Tungsten-Fabric address group name", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Tungsten-Fabric address group ip prefix length", - "name": "ipprefixlen", - "type": "int" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, { "description": "Tungsten-Fabric provider zone name", @@ -149474,14 +150588,14 @@ "type": "string" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "Tungsten-Fabric address group ip prefix length", + "name": "ipprefixlen", + "type": "int" }, { - "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 address group ip prefix", @@ -149496,11 +150610,11 @@ "name": "listBigSwitchBcfDevices", "params": [ { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { "description": "bigswitch BCF controller device ID", @@ -149511,11 +150625,12 @@ "type": "uuid" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "", @@ -149525,43 +150640,35 @@ "type": "integer" }, { - "description": "the Physical Network ID", + "description": "", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "device id of the BigSwitch BCF Controller", - "name": "bcfdeviceid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "NAT support", - "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", + "description": "device id of the BigSwitch BCF Controller", + "name": "bcfdeviceid", "type": "string" }, - {}, { "description": "name of the provider", "name": "provider", "type": "string" }, + { + "description": "device name", + "name": "bigswitchdevicename", + "type": "string" + }, { "description": "the controller Ip address", "name": "hostname", @@ -149572,6 +150679,7 @@ "name": "username", "type": "string" }, + {}, { "description": "the physical network to which this BigSwitch BCF segment belongs to", "name": "physicalnetworkid", @@ -149582,10 +150690,16 @@ "name": "password", "type": "string" }, + {}, + { + "description": "NAT support", + "name": "nat", + "type": "boolean" + }, { - "description": "device name", - "name": "bigswitchdevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.6.0" @@ -149596,55 +150710,55 @@ "name": "listRegisteredServicePackages", "params": [ { - "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" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ - {}, { - "description": "Service Package Name", - "name": "name", + "description": "Description of Service Package", + "name": "description", "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", "type": "string" }, { - "description": "Description of Service Package", - "name": "description", + "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": "Service Package Name", + "name": "name", "type": "string" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -149654,9 +150768,17 @@ "name": "changeSharedFileSystemDiskOffering", "params": [ { - "description": "min iops", + "description": "the ID of the shared filesystem", "length": 255, - "name": "miniops", + "name": "id", + "related": "changeSharedFileSystemDiskOffering", + "required": true, + "type": "uuid" + }, + { + "description": "max iops", + "length": 255, + "name": "maxiops", "required": false, "type": "long" }, @@ -149668,334 +150790,180 @@ "type": "long" }, { - "description": "the disk offering to use for the underlying storage", + "description": "min iops", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "miniops", "required": false, - "type": "uuid" - }, - { - "description": "the ID of the shared filesystem", - "length": 255, - "name": "id", - "related": "changeSharedFileSystemDiskOffering", - "required": true, - "type": "uuid" + "type": "long" }, { - "description": "max iops", + "description": "the disk offering to use for the underlying storage", "length": 255, - "name": "maxiops", + "name": "diskofferingid", + "related": "", "required": false, - "type": "long" + "type": "uuid" } ], "related": "", "response": [ { - "description": "the account associated with the shared filesystem", - "name": "account", + "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": "Network ID of the shared filesystem", + "name": "networkid", "type": "string" }, { - "description": "ID of the storage pool hosting the data volume", - "name": "storageid", + "description": "the shared filesystem provider", + "name": "provider", "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": "resource type", - "name": "resourcetype", - "type": "string" - }, - { - "description": "tag value", - "name": "value", - "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": "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": "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 domain associated with the shared filesystem", + "name": "domain", + "type": "string" }, { - "description": "the list of nics associated with the shared filesystem", - "name": "nic", - "response": [ - { - "description": "the name of the corresponding network", - "name": "networkname", - "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": "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", - "type": "string" - }, - { - "description": "Type of adapter if available", - "name": "adaptertype", - "type": "string" - }, - { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" - }, - { - "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 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", - "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 isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" - }, - { - "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", - "type": "string" - }, + "description": "path of the domain to which the shared filesystem", + "name": "domainpath", + "type": "string" + }, + { + "description": "provisioning type used in the shared filesystem", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "ID of the storage pool hosting the data volume", + "name": "storageid", + "type": "string" + }, + { + "description": "the ID of the domain associated with the shared filesystem", + "name": "domainid", + "type": "string" + }, + { + "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": "name of the storage fs data volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account associated with the tag", + "name": "account", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "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": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 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": "the ip address of the nic", - "name": "ipaddress", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], - "type": "list" - }, - { - "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": "disk offering ID for the shared filesystem", - "name": "diskofferingid", - "type": "string" + "type": "set" }, { - "description": "size of the shared filesystem in GiB", - "name": "sizegb", + "description": "ID of the storage fs vm", + "name": "virtualmachineid", "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", + "description": "the account associated with the shared filesystem", + "name": "account", "type": "string" }, { - "description": "ID of the shared filesystem", - "name": "id", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "ID of the storage fs data volume", - "name": "volumeid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "disk offering display text for the shared filesystem", - "name": "diskofferingdisplaytext", + "description": "service offering for the shared filesystem", + "name": "serviceofferingname", "type": "string" }, - { - "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": "Network name of the shared filesystem", - "name": "networkname", - "type": "string" - }, - { - "description": "the project ID of the shared filesystem", - "name": "projectid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "Network ID of the shared filesystem", - "name": "networkid", + "description": "name of the storage pool hosting the data volume", + "name": "storage", "type": "string" }, { @@ -150004,23 +150972,8 @@ "type": "long" }, { - "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 state of the shared filesystem", - "name": "state", - "type": "string" - }, - { - "description": "service offering ID for the shared filesystem", - "name": "serviceofferingid", + "description": "ID of the shared filesystem", + "name": "id", "type": "string" }, { @@ -150029,19 +150982,19 @@ "type": "long" }, { - "description": "the ID of the domain associated with the shared filesystem", - "name": "domainid", + "description": "name of the shared filesystem", + "name": "name", "type": "string" }, { - "description": "the domain associated with the shared filesystem", - "name": "domain", + "description": "size of the shared filesystem in GiB", + "name": "sizegb", "type": "string" }, { - "description": "name of the shared filesystem", - "name": "name", - "type": "string" + "description": "the write (IO) of disk on the shared filesystem", + "name": "diskiowrite", + "type": "long" }, { "description": "Name of the availability zone", @@ -150049,25 +151002,24 @@ "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 shared filesystem", + "name": "project", + "type": "string" }, { - "description": "name of the storage pool hosting the data volume", - "name": "storage", + "description": "disk offering for the shared filesystem", + "name": "diskofferingname", "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": "disk offering for the shared filesystem has custom size", - "name": "iscustomdiskoffering", - "type": "boolean" + "description": "description of the shared filesystem", + "name": "description", + "type": "string" }, { "description": "the filesystem format", @@ -150075,29 +151027,34 @@ "type": "string" }, { - "description": "the write (IO) of disk on the shared filesystem", - "name": "diskiowrite", + "description": "service offering ID for the shared filesystem", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the read (IO) of disk on the shared filesystem", + "name": "diskioread", "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the project ID of the shared filesystem", + "name": "projectid", "type": "string" }, { - "description": "the shared filesystem's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "disk offering for the shared filesystem has custom size", + "name": "iscustomdiskoffering", + "type": "boolean" }, { - "description": "ID of the storage fs vm", - "name": "virtualmachineid", + "description": "disk offering display text for the shared filesystem", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "Network name of the shared filesystem", + "name": "networkname", + "type": "string" }, { "description": "path to mount the shared filesystem", @@ -150105,29 +151062,186 @@ "type": "string" }, { - "description": "the shared filesystem provider", - "name": "provider", - "type": "string" + "description": "the shared filesystem's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "description of the shared filesystem", - "name": "description", + "description": "the state of the shared filesystem", + "name": "state", "type": "string" }, { - "description": "service offering for the shared filesystem", - "name": "serviceofferingname", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "ID of the storage fs data volume", + "name": "volumeid", + "type": "string" }, { - "description": "disk offering for the shared filesystem", - "name": "diskofferingname", - "type": "string" + "description": "the list of nics associated with the shared filesystem", + "name": "nic", + "response": [ + { + "description": "the isolation uri of the nic", + "name": "isolationuri", + "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": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", + "name": "nsxlogicalswitchport", + "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": "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": "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", + "type": "string" + }, + { + "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 extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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 type of the nic", + "name": "type", + "type": "string" + }, + { + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the IPv6 address of network", + "name": "ip6address", + "type": "string" + }, + { + "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 VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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": "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": "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + }, + { + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" + } + ], + "type": "list" } ], "since": "4.20.0" @@ -150137,11 +151251,19 @@ "isasync": false, "name": "enableStaticNat", "params": [ + { + "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" + }, { "description": "the ID of the virtual machine for enabling static NAT feature", "length": 255, "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,listVnfAppliances,importVm", + "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,createVMFromBackup,importVm", "required": true, "type": "uuid" }, @@ -150159,24 +151281,19 @@ "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": "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", @@ -150187,11 +151304,8 @@ "name": "success", "type": "boolean" }, - { - "description": "any text associated with the success or failure", - "name": "displaytext", - "type": "string" - } + {}, + {} ] }, { @@ -150209,27 +151323,27 @@ } ], "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" } ] }, @@ -150254,9 +151368,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" }, {}, { @@ -150265,9 +151379,9 @@ "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" }, {} ], @@ -150279,12 +151393,12 @@ "name": "getUploadParamsForTemplate", "params": [ { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "forcks", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { "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.", @@ -150295,68 +151409,62 @@ "type": "uuid" }, { - "description": "true if the template or its derivatives are extractable; default is false", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isextractable", + "name": "sshkeyenabled", "required": false, "type": "boolean" }, { - "description": "the display text of the template. This is usually used for display purposes.", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "the ID of the zone the volume/template/iso is to be hosted on", "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "true if the template is available to all accounts; default is true", + "description": "the tag for this template.", "length": 255, - "name": "ispublic", + "name": "templatetag", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "Template details in key/value pairs.", + "description": "the name of the volume/template/iso", "length": 255, - "name": "details", - "required": false, - "type": "map" + "name": "name", + "required": true, + "type": "string" }, { - "description": "true if this template requires HVM", + "description": "Upload volume/template/iso for the project", "length": 255, - "name": "requireshvm", + "name": "projectid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "if true, the templates would be available for deploying CKS clusters", - "length": 255, - "name": "forcks", + "description": "the display text of the template. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "string" }, { - "description": "the name of the volume/template/iso", + "description": "the target hypervisor for the template", "length": 255, - "name": "name", + "name": "hypervisor", "required": true, "type": "string" }, { - "description": "an optional accountName. Must be used with domainId.", + "description": "true if this template requires HVM", "length": 255, - "name": "account", + "name": "requireshvm", "required": false, - "type": "string" + "type": "boolean" }, { "description": "(VMware only) true if VM deployments should preserve all the configurations defined for this template", @@ -150374,105 +151482,102 @@ "type": "boolean" }, { - "description": "true if the template supports the password reset feature; default is false", + "description": "an optional accountName. Must be used with domainId.", "length": 255, - "name": "passwordenabled", + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", "required": false, "type": "boolean" }, { - "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": "true if this template is a featured template, false otherwise", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "isfeatured", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "Template details in key/value pairs.", "length": 255, - "name": "bits", + "name": "details", "required": false, - "type": "integer" + "type": "map" }, { - "description": "the tag for this template.", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "templatetag", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "checksum", "required": false, - "since": "4.20", "type": "string" }, { - "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" }, { - "description": "the target hypervisor for the template", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "hypervisor", + "name": "bits", + "required": false, + "type": "integer" + }, + { + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", "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.", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "checksum", + "name": "templatetype", "required": false, + "since": "4.22.0", "type": "string" }, { - "description": "Upload volume/template/iso for the project", + "description": "true if the template supports the password reset feature; default is false", "length": 255, - "name": "projectid", - "related": "", + "name": "passwordenabled", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "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" } ], "related": "getUploadParamsForIso", "response": [ - { - "description": "the template/volume ID", - "name": "id", - "type": "uuid" - }, - { - "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", - "type": "string" - }, - {}, - {}, { "description": "POST url to upload the file to", "name": "postURL", @@ -150483,11 +151588,28 @@ "name": "jobstatus", "type": "integer" }, + { + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" + }, { "description": "the timestamp after which the signature expires", "name": "expires", "type": "string" }, + {}, + { + "description": "signature to be sent in the POST request.", + "name": "signature", + "type": "string" + }, + { + "description": "the template/volume ID", + "name": "id", + "type": "uuid" + }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -150502,27 +151624,28 @@ "name": "deleteSnapshotPolicies", "params": [ { - "description": "list of snapshots policy IDs separated by comma", + "description": "the Id of the snapshot policy", "length": 255, - "name": "ids", + "name": "id", "related": "updateSnapshotPolicy", "required": false, - "type": "list" + "type": "uuid" }, { - "description": "the Id of the snapshot policy", + "description": "list of snapshots policy IDs separated by comma", "length": 255, - "name": "id", + "name": "ids", "related": "updateSnapshotPolicy", "required": false, - "type": "uuid" + "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 UUID of the latest async job acting on this object", @@ -150530,17 +151653,16 @@ "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" - }, - {}, - {} + } ] }, { @@ -150559,17 +151681,16 @@ ], "related": "", "response": [ - { - "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": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "Zone ID to which the Netris Provider is associated with", "name": "zoneid", @@ -150580,37 +151701,38 @@ "name": "netrisurl", "type": "string" }, + {}, { - "description": "Netris Provider site", - "name": "sitename", + "description": "Netris Admin tenant name", + "name": "tenantname", "type": "string" }, { - "description": "Netris provider uuid", - "name": "uuid", + "description": "Zone name to which the Netris Provider is associated with", + "name": "zonename", "type": "string" }, { - "description": "Netris Admin tenant name", - "name": "tenantname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "Netris Provider name", - "name": "name", + "description": "Netris Provider site", + "name": "sitename", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Netris provider uuid", + "name": "uuid", + "type": "string" }, { - "description": "Zone name to which the Netris Provider is associated with", - "name": "zonename", + "description": "Netris Provider name", + "name": "name", "type": "string" - } + }, + {} ], "since": "4.21.0" }, @@ -150620,32 +151742,32 @@ "name": "listTrafficTypeImplementors", "params": [ { - "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" }, { - "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": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "Optional. The network traffic type, if specified, return its implementor. Otherwise, return all traffic types with their implementor", "length": 255, - "name": "page", + "name": "traffictype", "required": false, - "type": "integer" + "type": "string" } ], "related": "", @@ -150655,22 +151777,22 @@ "name": "traffictypeimplementor", "type": "string" }, + { + "description": "network traffic type", + "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": "network traffic type", - "name": "traffictype", - "type": "string" - }, - {}, {} ], "since": "3.0.0" @@ -150683,34 +151805,25 @@ "related": "", "response": [ { - "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 tls versions currently in use (accepted) by the DB", - "name": "tlsversions", + "description": "the name of the active usage server", + "name": "hostname", "type": "string" }, + {}, { "description": "the version of the currently running DB", - "name": "versioncomment", + "name": "version", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the version of the currently running DB", + "name": "versioncomment", "type": "string" }, { - "description": "the uptime of the DB in seconds", - "name": "uptime", - "type": "long" + "description": "the time these statistics were collected", + "name": "collectiontime", + "type": "date" }, { "description": "the last measured load averages on the DB", @@ -150718,31 +151831,40 @@ "type": "double[]" }, { - "description": "the name of the active usage server", - "name": "hostname", - "type": "string" + "description": "the number of connections to the DB", + "name": "connections", + "type": "int" }, { - "description": "the version of the currently running DB", - "name": "version", - "type": "string" + "description": "the uptime of the DB in seconds", + "name": "uptime", + "type": "long" }, { - "description": "the number of connections to the DB", - "name": "connections", - "type": "int" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the number of queries performed on the DB", "name": "queries", "type": "long" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the state of the usage server", "name": "replicas", "type": "string[]" }, - {}, + { + "description": "the tls versions currently in use (accepted) by the DB", + "name": "tlsversions", + "type": "string" + }, {} ], "since": "4.17.0" @@ -150763,27 +151885,27 @@ ], "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": "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.2.0" }, @@ -150793,39 +151915,34 @@ "name": "listAutoScaleVmProfiles", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "the ID of the autoscale vm profile", + "description": "list profiles by service offering id", "length": 255, - "name": "id", - "related": "listAutoScaleVmProfiles", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, + "since": "4.4", "type": "uuid" }, { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the templateid of the autoscale vm profile", "length": 255, - "name": "account", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the templateid of the autoscale vm profile", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "templateid", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -150839,17 +151956,11 @@ "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": "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" }, { @@ -150861,20 +151972,34 @@ "type": "uuid" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "the ID of the autoscale vm profile", "length": 255, - "name": "fordisplay", + "name": "id", + "related": "listAutoScaleVmProfiles", "required": false, - "since": "4.4", - "type": "boolean" + "type": "uuid" }, { "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" + }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "the otherdeployparameters of the autoscale vm profile", "length": 255, @@ -150883,21 +152008,18 @@ "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "List by keyword", "length": 255, - "name": "projectid", - "related": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list profiles by service offering 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": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "listall", "required": false, - "since": "4.4", - "type": "uuid" + "type": "boolean" } ], "related": "", @@ -150908,108 +152030,108 @@ "type": "integer" }, { - "description": "the ID of the user used to launch and destroy the VMs", - "name": "autoscaleuserid", + "description": "the project id vm profile", + "name": "projectid", "type": "string" }, { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", + "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", "type": "string" }, { - "description": "Base64 encoded VM user data", - "name": "userdata", + "description": "the domain name of the vm profile", + "name": "domain", "type": "string" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "the domain ID of the vm profile", + "name": "domainid", "type": "string" }, { - "description": "the project id vm profile", - "name": "projectid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, {}, {}, + {}, { - "description": "the account owning the instance group", - "name": "account", + "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", + "name": "otherdeployparams", + "type": "map" + }, + { + "description": "the availability zone to be used while deploying a virtual machine", + "name": "zoneid", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the service offering to be used while deploying a virtual machine", + "name": "serviceofferingid", "type": "string" }, - {}, { "description": "the project name of the vm profile", "name": "project", "type": "string" }, { - "description": "the autoscale vm profile ID", - "name": "id", + "description": "is profile for display to the regular user", + "name": "fordisplay", + "type": "boolean" + }, + { + "description": "path of the domain to which the vm profile belongs", + "name": "domainpath", "type": "string" }, + {}, { "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 template to be used while deploying a virtual machine", + "name": "templateid", "type": "string" }, - {}, - { - "description": "parameters other than zoneId/serviceOfferringId/templateId to be used while deploying a virtual machine", - "name": "otherdeployparams", - "type": "map" - }, - { - "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", + "description": "the autoscale vm profile ID", + "name": "id", "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", + "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 account owning the instance group", + "name": "account", "type": "string" }, { - "description": "the availability zone to be used while deploying a virtual machine", - "name": "zoneid", + "description": "the ID of the user used to launch and destroy the VMs", + "name": "autoscaleuserid", "type": "string" }, { - "description": "the domain ID of the vm profile", - "name": "domainid", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" - }, - { - "description": "is profile for display to the regular user", - "name": "fordisplay", - "type": "boolean" } ] }, @@ -151019,63 +152141,70 @@ "name": "authorizeSecurityGroupIngress", "params": [ { - "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": "securitygroupname", + "required": false, + "type": "string" + }, + { + "description": "type of the icmp message being sent", + "length": 255, + "name": "icmptype", + "required": false, + "type": "integer" + }, + { + "description": "end port for this ingress rule", "length": 255, - "name": "protocol", + "name": "endport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "error code for this icmp message", + "description": "user to security group mapping", "length": 255, - "name": "icmpcode", + "name": "usersecuritygrouplist", "required": false, - "type": "integer" + "type": "map" }, { - "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", + "description": "an optional project of the security group", "length": 255, - "name": "securitygroupid", + "name": "projectid", "related": "", "required": false, "type": "uuid" }, { - "description": "The name of the security group. Mutually exclusive with securityGroupId parameter", + "description": "start port for this ingress rule", "length": 255, - "name": "securitygroupname", + "name": "startport", "required": false, - "type": "string" + "type": "integer" }, { - "description": "user to security group mapping", + "description": "the cidr list associated. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "usersecuritygrouplist", + "name": "cidrlist", "required": false, - "type": "map" + "type": "list" }, { - "description": "an optional account for the security group. Must be used with domainId.", + "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": "account", + "name": "protocol", "required": false, "type": "string" }, { - "description": "an optional project of the security group", + "description": "The ID of the security group. Mutually exclusive with securityGroupName parameter", "length": 255, - "name": "projectid", + "name": "securitygroupid", "related": "", "required": false, "type": "uuid" }, - { - "description": "type of the icmp message being sent", - "length": 255, - "name": "icmptype", - "required": false, - "type": "integer" - }, { "description": "an optional domainId for the security group. If the account parameter is used, domainId must also be used.", "length": 255, @@ -151085,97 +152214,44 @@ "type": "uuid" }, { - "description": "end port for this ingress rule", - "length": 255, - "name": "endport", - "required": false, - "type": "integer" - }, - { - "description": "start port for this ingress rule", + "description": "error code for this icmp message", "length": 255, - "name": "startport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "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" } ], "related": "", "response": [ - { - "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 starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "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 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 account associated with the tag", - "name": "account", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name where tag belongs to", + "name": "project", "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": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -151184,8 +152260,8 @@ "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag key name", + "name": "key", "type": "string" }, { @@ -151194,23 +152270,23 @@ "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": "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": "the project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" } ], @@ -151221,11 +152297,57 @@ "name": "ruleid", "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 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 ending IP of the security group rule ", + "name": "endport", + "type": "integer" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "account owning the security group rule", "name": "account", "type": "string" + }, + { + "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" + }, + { + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" } ] }, @@ -151246,38 +152368,23 @@ "related": "cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" - }, - { - "description": "the host's currently used disk size", + "description": "the pool's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the name of the storage pool", + "name": "name", "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 date and time the storage pool was created", - "name": "created", - "type": "date" - }, - { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", "type": "long" }, { @@ -151286,141 +152393,161 @@ "type": "string" }, { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "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 ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the hypervisor type of the storage pool", + "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 storage pool", - "name": "id", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", - "type": "long" + "description": "the storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", "type": "string" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "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": "Storage provider for this pool", - "name": "provider", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, + { + "description": "the storage pool details", + "name": "details", + "type": "map" + }, { "description": "the total disk size of the storage pool", "name": "disksizetotal", "type": "long" }, - { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" - }, - { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" - }, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" - }, - { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, + {}, { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", "type": "boolean" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "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": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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 type", + "name": "type", + "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 this pool is suitable to migrate a volume, false otherwise", "name": "suitableformigration", "type": "boolean" + }, + { + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" + }, + { + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the scope of the storage pool", + "name": "scope", + "type": "string" + }, + { + "description": "the storage pool path", + "name": "path", + "type": "string" } ], "since": "4.15.1" @@ -151431,9 +152558,9 @@ "name": "updateBucket", "params": [ { - "description": "Enable/Disable Bucket encryption", + "description": "Enable/Disable Bucket Versioning", "length": 255, - "name": "encryption", + "name": "versioning", "required": false, "type": "boolean" }, @@ -151444,6 +152571,13 @@ "required": false, "type": "string" }, + { + "description": "Enable/Disable Bucket encryption", + "length": 255, + "name": "encryption", + "required": false, + "type": "boolean" + }, { "description": "The ID of the Bucket", "length": 255, @@ -151458,37 +152592,30 @@ "name": "quota", "required": false, "type": "integer" - }, - { - "description": "Enable/Disable Bucket Versioning", - "length": 255, - "name": "versioning", - "required": false, - "type": "boolean" } ], "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": "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" } ], "since": "4.19.0" @@ -151498,13 +152625,6 @@ "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, @@ -151514,12 +152634,11 @@ "type": "uuid" }, { - "description": "Tag for the resource type", + "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": "tag", + "name": "resourcetype", "required": false, - "since": "4.20.0", - "type": "string" + "type": "integer" }, { "description": "Update resource count for a specified account. Must be used with the domainId parameter.", @@ -151535,55 +152654,58 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" } ], "related": "", "response": [ { - "description": "the account for which resource count's are updated", - "name": "account", + "description": "the domain name for which resource count's are updated", + "name": "domain", "type": "string" }, { - "description": "the project name for which resource count's are updated", - "name": "project", + "description": "the project id for which resource count's are updated", + "name": "projectid", "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, {}, { - "description": "The resource count", - "name": "resourcecount", - "type": "long" - }, - { - "description": "path of the domain to which the resource counts are updated", - "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" }, { - "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 account for which resource count's are updated", + "name": "account", "type": "string" }, {}, { - "description": "the project id for which resource count's are updated", - "name": "projectid", + "description": "the domain ID for which resource count's are updated", + "name": "domainid", "type": "string" }, { - "description": "the domain name for which resource count's are updated", - "name": "domain", + "description": "The resource count", + "name": "resourcecount", + "type": "long" + }, + { + "description": "the project name for which resource count's are updated", + "name": "project", "type": "string" }, { @@ -151591,15 +152713,20 @@ "name": "tag", "type": "string" }, + { + "description": "path of the domain to which the resource counts are updated", + "name": "domainpath", + "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" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -151609,11 +152736,18 @@ "name": "listRoles", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" }, { "description": "List role by role type status, valid options are: enabled, disabled", @@ -151623,25 +152757,25 @@ "type": "string" }, { - "description": "List role by role name.", + "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", "length": 255, - "name": "name", + "name": "type", "required": false, "type": "string" }, { - "description": "List role by role type, valid options are: Admin, ResourceAdmin, DomainAdmin, User.", + "description": "List by keyword", "length": 255, - "name": "type", + "name": "keyword", "required": false, "type": "string" }, { - "description": "", + "description": "List role by role name.", "length": 255, - "name": "pagesize", + "name": "name", "required": false, - "type": "integer" + "type": "string" }, { "description": "List role by role ID.", @@ -151650,46 +152784,35 @@ "related": "listRoles", "required": false, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ - { - "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 type of the role", "name": "type", "type": "string" }, { - "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", - "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": "true if role is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the ID of the role", + "name": "id", + "type": "string" }, { "description": "the name of the role", @@ -151698,16 +152821,20 @@ }, {}, { - "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": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, - {} + { + "description": "the state of the role", + "name": "state", + "type": "string" + } ], "since": "4.9.0" }, @@ -151717,76 +152844,82 @@ "name": "listTungstenFabricPolicy", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of network", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", + "name": "policyuuid", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the ID of zone", + "description": "the ID of ip address", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "ipaddressid", + "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", "required": false, "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "page", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of ip address", + "description": "the ID of network", "length": 255, - "name": "ipaddressid", - "related": "updateIpAddress,associateIpAddress,listPublicIpAddresses", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, "type": "uuid" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "", "length": 255, - "name": "policyuuid", + "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" } ], "related": "", "response": [ { - "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 id", "name": "zoneid", "type": "long" }, - {}, { "description": "Tungsten-Fabric provider zone name", "name": "zonename", "type": "string" }, + { + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -151798,16 +152931,10 @@ "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 tag type uuid", + "name": "uuid", + "type": "string" } ] }, @@ -151834,35 +152961,39 @@ ], "related": "extractSnapshot,extractTemplate", "response": [ - {}, { - "description": "zone name the object was extracted from", - "name": "zonename", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "description": "the percentage of the entity uploaded to the specified location", - "name": "uploadpercentage", + "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 name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the percentage of the entity uploaded to the specified location", + "name": "uploadpercentage", + "type": "integer" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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" }, { @@ -151871,28 +153002,24 @@ "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": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the upload id of extracted object", + "name": "extractId", "type": "string" }, + {}, { - "description": "type of the storage", - "name": "storagetype", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, { @@ -151902,18 +153029,18 @@ }, {}, { - "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": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "zone name the object was extracted from", + "name": "zonename", + "type": "string" }, { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the id of extracted object", + "name": "id", "type": "string" } ], @@ -151935,18 +153062,18 @@ ], "related": "", "response": [ - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - {}, { "description": "the cloud identifier", "name": "cloudidentifier", "type": "string" }, {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, { "description": "the signed response for the cloud identifier", "name": "signature", @@ -151969,14 +153096,6 @@ "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, @@ -151985,12 +153104,11 @@ "type": "string" }, { - "description": "the ID of the load balancer rule", + "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", "length": 255, - "name": "lbruleid", - "related": "", - "required": true, - "type": "uuid" + "name": "param", + "required": false, + "type": "map" }, { "description": "name of the load balancer stickiness policy method, possible values are LbCookie, AppCookie, SourceBased", @@ -151999,6 +153117,14 @@ "required": true, "type": "string" }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "lbruleid", + "related": "", + "required": true, + "type": "uuid" + }, { "description": "name of the load balancer stickiness policy", "length": 255, @@ -152007,39 +153133,34 @@ "type": "string" }, { - "description": "param list. Example: param[0].name=cookiename¶m[0].value=LBCookie ", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "param", + "name": "fordisplay", "required": false, - "type": "map" + "since": "4.4", + "type": "boolean" } ], "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", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, - {}, { "description": "the LB rule ID", "name": "lbruleid", "type": "string" }, { - "description": "the domain ID of the Stickiness policy", - "name": "domainid", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain ID of the Stickiness policy", + "name": "domainid", "type": "string" }, { @@ -152048,37 +153169,23 @@ "type": "integer" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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", - "type": "string" - }, { "description": "the list of stickinesspolicies", "name": "stickinesspolicy", "response": [ { - "description": "the description of the Stickiness policy", - "name": "description", - "type": "string" - }, - { - "description": "the method name of the Stickiness policy", - "name": "methodname", + "description": "the name of the Stickiness policy", + "name": "name", "type": "string" }, { @@ -152087,28 +153194,48 @@ "type": "map" }, { - "description": "is policy for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "the state of the policy", + "name": "state", + "type": "string" }, { - "description": "the name of the Stickiness policy", - "name": "name", + "description": "the description of the Stickiness policy", + "name": "description", "type": "string" }, { - "description": "the state of the policy", - "name": "state", - "type": "string" + "description": "is policy for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "the LB Stickiness policy ID", "name": "id", "type": "string" + }, + { + "description": "the method name of the Stickiness policy", + "name": "methodname", + "type": "string" } ], "type": "list" }, + { + "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 domain of the Stickiness policy", + "name": "domain", + "type": "string" + }, {} ], "since": "3.0.0" @@ -152118,6 +153245,14 @@ "isasync": false, "name": "addCiscoAsa1000vResource", "params": [ + { + "description": "the Cluster ID", + "length": 255, + "name": "clusterid", + "related": "addCluster", + "required": true, + "type": "uuid" + }, { "description": "the Physical Network ID", "length": 255, @@ -152139,14 +153274,6 @@ "name": "insideportprofile", "required": true, "type": "string" - }, - { - "description": "the Cluster ID", - "length": 255, - "name": "clusterid", - "related": "addCluster", - "required": true, - "type": "uuid" } ], "related": "", @@ -152154,19 +153281,19 @@ {}, {}, {}, - {}, { "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" }, - {}, {} ] }, @@ -152175,6 +153302,13 @@ "isasync": true, "name": "configurePaloAltoFirewall", "params": [ + { + "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", + "length": 255, + "name": "fwdevicecapacity", + "required": false, + "type": "long" + }, { "description": "Palo Alto firewall device ID", "length": 255, @@ -152182,31 +153316,24 @@ "related": "configurePaloAltoFirewall,listPaloAltoFirewalls", "required": true, "type": "uuid" - }, - { - "description": "capacity of the firewall device, Capacity will be interpreted as number of networks device can handle", - "length": 255, - "name": "fwdevicecapacity", - "required": false, - "type": "long" } ], "related": "listPaloAltoFirewalls", "response": [ { - "description": "device name", - "name": "fwdevicename", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device capacity", - "name": "fwdevicecapacity", - "type": "long" + "description": "the username that's used to log in to the external firewall", + "name": "username", + "type": "string" }, { "description": "the public security zone of the external firewall", @@ -152214,75 +153341,75 @@ "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 private security zone of the external firewall", - "name": "privatezone", + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the private interface of the external firewall", - "name": "privateinterface", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the management IP address of the external firewall", - "name": "ipaddress", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, - {}, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the private interface of the external firewall", + "name": "privateinterface", "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 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": "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": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the usage interface of the external firewall", + "name": "usageinterface", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the management IP address of the external firewall", + "name": "ipaddress", "type": "string" } ] @@ -152293,37 +153420,30 @@ "name": "updateNetworkACLItem", "params": [ { - "description": "A description indicating why the ACL rule is required.", - "length": 255, - "name": "reason", - "required": false, - "type": "string" - }, - { - "description": "type of the ICMP message being sent", + "description": "The network of the vm the ACL will be created for", "length": 255, - "name": "icmptype", + "name": "number", "required": false, "type": "integer" }, { - "description": "the starting port of ACL", + "description": "the ending port of ACL", "length": 255, - "name": "startport", + "name": "endport", "required": false, "type": "integer" }, { - "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", + "description": "scl entry action, allow or deny", "length": 255, - "name": "protocol", + "name": "action", "required": false, "type": "string" }, { - "description": "scl entry action, allow or deny", + "description": "the protocol for the ACL rule. Valid values are TCP/UDP/ICMP/ALL or valid protocol number", "length": 255, - "name": "action", + "name": "protocol", "required": false, "type": "string" }, @@ -152336,31 +153456,30 @@ "type": "boolean" }, { - "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": "the cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", + "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", "length": 255, - "name": "cidrlist", + "name": "traffictype", "required": false, - "type": "list" + "type": "string" }, { - "description": "the ID of the network ACL item", + "description": "type of the ICMP message being sent", "length": 255, - "name": "id", - "related": "updateNetworkACLItem,moveNetworkAclItem", - "required": true, - "type": "uuid" + "name": "icmptype", + "required": false, + "type": "integer" }, { - "description": "the ending port of ACL", + "description": "the starting port of ACL", "length": 255, - "name": "endport", + "name": "startport", "required": false, "type": "integer" }, @@ -152373,11 +153492,19 @@ "type": "string" }, { - "description": "the traffic type for the ACL, can be Ingress or Egress, defaulted to Ingress if not specified", + "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": "traffictype", + "name": "partialupgrade", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "the ID of the network ACL item", + "length": 255, + "name": "id", + "related": "updateNetworkACLItem,moveNetworkAclItem", + "required": true, + "type": "uuid" }, { "description": "error code for this ICMP message", @@ -152387,39 +153514,54 @@ "type": "integer" }, { - "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 cidr list to allow traffic from/to. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "partialupgrade", + "name": "cidrlist", "required": false, - "type": "boolean" + "type": "list" } ], "related": "moveNetworkAclItem", "response": [ { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "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 ACL Item", + "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", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "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": "an explanation on why this ACL rule is being applied", + "name": "reason", + "type": "string" }, + {}, { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "description": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { @@ -152433,23 +153575,13 @@ "type": "integer" }, { - "description": "the ending port of ACL's port range", - "name": "endport", - "type": "string" - }, - { - "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", + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { @@ -152462,78 +153594,68 @@ "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "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": "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": "resource type", - "name": "resourcetype", + "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 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": "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" } ], "type": "list" }, { - "description": "the ID of the ACL Item", - "name": "id", - "type": "string" - }, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" }, {}, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "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", @@ -152541,8 +153663,13 @@ "type": "integer" }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", + "type": "string" + }, + { + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" } ] @@ -152553,62 +153680,63 @@ "name": "listRouters", "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": "", + "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", "length": 255, - "name": "page", + "name": "fetchhealthcheckresults", "required": false, - "type": "integer" + "since": "4.14", + "type": "boolean" }, { - "description": "the cluster ID of the router", + "description": "list virtual router elements by version", "length": 255, - "name": "clusterid", - "related": "addCluster", + "name": "version", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List networks by VPC", + "description": "the Pod ID of the router", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "podid", + "related": "createManagementNetworkIpRange", "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": "if true is passed for this parameter, list only VPC routers", "length": 255, - "name": "listall", + "name": "forvpc", "required": false, "type": "boolean" }, { - "description": "the host ID of the router", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "domainid", + "related": "listDomains", "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 Zone ID of the router", "length": 255, - "name": "isrecursive", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "the ID of the disk router", + "description": "the host ID of the router", "length": 255, - "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", + "name": "hostid", + "related": "reconnectHost", "required": false, "type": "uuid" }, @@ -152620,78 +153748,71 @@ "type": "integer" }, { - "description": "list by network id", - "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", - "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": "listDomains", + "name": "isrecursive", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "the Zone ID of the router", + "description": "List networks by VPC", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, "type": "uuid" }, { - "description": "if true is passed for this parameter, list only VPC routers", + "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": "forvpc", + "name": "listall", "required": false, "type": "boolean" }, { - "description": "if true is passed for this parameter, also fetch last executed health check results for the router. Default is false", + "description": "the state of the router", "length": 255, - "name": "fetchhealthcheckresults", + "name": "state", "required": false, - "since": "4.14", - "type": "boolean" + "type": "string" }, { - "description": "the name of the router", + "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": "list by network id", "length": 255, - "name": "account", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks,migrateNetwork", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the Pod ID of the router", + "description": "if this parameter is passed, list only routers by health check results", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "healthchecksfailed", "required": false, - "type": "uuid" + "since": "4.16", + "type": "boolean" }, { - "description": "the state of the router", + "description": "the cluster ID of the router", "length": 255, - "name": "state", + "name": "clusterid", + "related": "addCluster", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "list virtual router elements by version", + "description": "CPU arch of the router", "length": 255, - "name": "version", + "name": "arch", "required": false, + "since": "4.20.1", "type": "string" }, { @@ -152703,125 +153824,43 @@ "type": "uuid" }, { - "description": "CPU arch of the router", + "description": "the name of the router", "length": 255, - "name": "arch", + "name": "name", "required": false, - "since": "4.20.1", "type": "string" }, { - "description": "if this parameter is passed, list only routers by health check results", + "description": "", "length": 255, - "name": "healthchecksfailed", + "name": "page", "required": false, - "since": "4.16", - "type": "boolean" + "type": "integer" + }, + { + "description": "the ID of the disk 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,createVMFromBackup,importVm", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the public netmask for the router", - "name": "publicnetmask", - "type": "string" - }, - { - "description": "the ID of the corresponding guest network", - "name": "guestnetworkid", - "type": "string" - }, - { - "description": "the guest MAC address for the router", - "name": "guestmacaddress", - "type": "string" - }, - { - "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": "path of the Domain the router belongs to", - "name": "domainpath", - "type": "string" - }, - { - "description": "the Zone ID for the router", - "name": "zoneid", + "description": "the account associated with the router", + "name": "account", "type": "string" }, - {}, { "description": "the project id of the ipaddress", "name": "projectid", "type": "string" }, { - "description": "the name of the router", - "name": "name", - "type": "string" - }, - { - "description": "the version of template", - "name": "version", - "type": "string" - }, - { - "description": "the template ID for the router", - "name": "templateid", - "type": "string" - }, - { - "description": "the host ID for the router", - "name": "hostid", - "type": "string" - }, - { - "description": "the name of the corresponding guest network", - "name": "guestnetworkname", + "description": "the domain ID associated with the router", + "name": "domainid", "type": "string" }, { @@ -152830,29 +153869,13 @@ "type": "string" }, { - "description": "the public IP address for the router", - "name": "publicip", - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "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 ID of the corresponding link local network", + "name": "linklocalnetworkid", "type": "string" }, { @@ -152861,28 +153884,18 @@ "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": "true if the router template requires upgrader", + "name": "requiresupgrade", + "type": "boolean" }, { - "description": "the project name of the address", - "name": "project", + "description": "the host ID for the router", + "name": "hostid", "type": "string" }, { - "description": "the domain associated with the router", - "name": "domain", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -152891,18 +153904,18 @@ "type": "string" }, { - "description": "the state of redundant virtual router", - "name": "redundantstate", + "description": "the ID of the corresponding guest network", + "name": "guestnetworkid", "type": "string" }, { - "description": "the ID of the corresponding public network", - "name": "publicnetworkid", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "role of the domain router", - "name": "role", + "description": "the link local netmask for the router", + "name": "linklocalnetmask", "type": "string" }, { @@ -152911,53 +153924,23 @@ "type": "string" }, { - "description": "true if the router template requires upgrader", - "name": "requiresupgrade", - "type": "boolean" - }, - { - "description": "the gateway for the router", - "name": "gateway", - "type": "string" - }, - { - "description": "the name of VPC the router belongs to", - "name": "vpcname", - "type": "string" - }, - { - "description": "the Pod ID for the router", - "name": "podid", - "type": "string" - }, - { - "description": "VPC the router belongs to", - "name": "vpcid", - "type": "string" - }, - { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "the guest IP address for the router", - "name": "guestipaddress", + "description": "the id of the router", + "name": "id", "type": "string" }, { - "description": "the ID of the corresponding link local network", - "name": "linklocalnetworkid", + "description": "the link local MAC address for the router", + "name": "linklocalmacaddress", "type": "string" }, { - "description": "the control state of the host for the router", - "name": "hostcontrolstate", + "description": "the template name for the router", + "name": "templatename", "type": "string" }, { - "description": "the template name for the router", - "name": "templatename", + "description": "the state of redundant virtual router", + "name": "redundantstate", "type": "string" }, { @@ -152966,68 +153949,68 @@ "type": "boolean" }, { - "description": "the version of the code / software in the router", - "name": "softwareversion", + "description": "the guest MAC address for the router", + "name": "guestmacaddress", "type": "string" }, { - "description": "the version of scripts", - "name": "scriptsversion", + "description": "the template ID for the router", + "name": "templateid", "type": "string" }, { - "description": "the first DNS for the router", - "name": "dns1", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the second DNS for the router", - "name": "dns2", - "type": "string" + "description": "the state of the router", + "name": "state", + "type": "state" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the Pod ID for the router", + "name": "podid", + "type": "string" }, { - "description": "the link local IP address for the router", - "name": "linklocalip", + "description": "the name of the corresponding guest network", + "name": "guestnetworkname", "type": "string" }, { - "description": "the id of the router", - "name": "id", + "description": "the second IPv6 DNS for the router", + "name": "ip6dns2", "type": "string" }, { - "description": "the network domain for the router", - "name": "networkdomain", + "description": "the ID of the corresponding public network", + "name": "publicnetworkid", "type": "string" }, { - "description": "the domain ID associated with the router", - "name": "domainid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "type": "string" }, { - "description": "the account associated with the router", - "name": "account", + "description": "path of the Domain the router belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the first IPv6 DNS for the router", - "name": "ip6dns1", + "description": "the gateway for the router", + "name": "gateway", "type": "string" }, { - "description": "the second IPv6 DNS for the router", - "name": "ip6dns2", + "description": "role of the domain router", + "name": "role", "type": "string" }, { @@ -153035,68 +154018,93 @@ "name": "nic", "response": [ { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the name of the corresponding network", + "name": "networkname", "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 IPv6 address of network", - "name": "ip6address", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "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" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "MTU configured on the NIC", - "name": "mtu", - "type": "integer" + "description": "the gateway of the nic", + "name": "gateway", + "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "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": "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 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 NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + }, + { + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { @@ -153105,23 +154113,18 @@ "type": "boolean" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", - "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 broadcast uri of the nic", - "name": "broadcasturi", + "description": "Type of adapter if available", + "name": "adaptertype", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { @@ -153130,67 +154133,196 @@ "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "the ip address of the nic", + "name": "ipaddress", + "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": "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": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" + }, + { + "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": "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": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", + "type": "string" + } + ], + "type": "set" + }, + { + "description": "the version of scripts", + "name": "scriptsversion", + "type": "string" + }, + { + "description": "the control state of the host for the router", + "name": "hostcontrolstate", + "type": "string" + }, + { + "description": "the link local IP address for the router", + "name": "linklocalip", + "type": "string" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the version of template", + "name": "version", + "type": "string" + }, + { + "description": "the Zone name for the router", + "name": "zonename", + "type": "string" + }, + { + "description": "the second DNS for the router", + "name": "dns2", + "type": "string" + }, + { + "description": "the public netmask for the router", + "name": "publicnetmask", + "type": "string" + }, + { + "description": "the name of the router", + "name": "name", + "type": "string" + }, + { + "description": "the name of VPC the router belongs to", + "name": "vpcname", + "type": "string" + }, + { + "description": "VPC the router belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "true if any health checks had failed", + "name": "healthchecksfailed", + "type": "boolean" + }, + { + "description": "the public IP address for the router", + "name": "publicip", + "type": "string" + }, + { + "description": "the first DNS for the router", + "name": "dns1", + "type": "string" + }, + { + "description": "the network domain for the router", + "name": "networkdomain", + "type": "string" + }, + { + "description": "the guest IP address for the router", + "name": "guestipaddress", + "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 Zone ID for the router", + "name": "zoneid", + "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 isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "detailed response generated on running health check", + "name": "details", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "result of the health check if available", + "name": "success", + "type": "boolean" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the result of the health check in enum form: {SUCCESS, FAILURE, WARNING, UNKNOWN}", + "name": "status", + "type": "routerhealthstatus" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the type of the health check - basic or advanced", + "name": "checktype", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", - "type": "list" + "description": "the date this VPC was created", + "name": "lastupdated", + "type": "date" } ], - "type": "set" + "type": "list" + }, + { + "description": "the project name of the address", + "name": "project", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the router", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the version of the code / software in the router", + "name": "softwareversion", + "type": "string" } ] }, @@ -153200,11 +154332,12 @@ "name": "listTungstenFabricVm", "params": [ { - "description": "the uuid of Tungsten-Fabric vm", + "description": "the ID of zone", "length": 255, - "name": "vmuuid", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "string" + "type": "uuid" }, { "description": "List by keyword", @@ -153228,12 +154361,11 @@ "type": "integer" }, { - "description": "the ID of zone", + "description": "the uuid of Tungsten-Fabric vm", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "vmuuid", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", @@ -153244,32 +154376,32 @@ "type": "string" }, {}, - { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" - }, - { - "description": "Tungsten-Fabric vm 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": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" + }, { "description": "Tungsten-Fabric nic uuid", "name": "uuid", "type": "string" }, - {} + { + "description": "Tungsten-Fabric vm name", + "name": "name", + "type": "string" + } ] }, { @@ -153287,12 +154419,17 @@ } ], "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" }, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -153300,14 +154437,9 @@ }, {}, { - "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" } ], "since": "3.0.0" @@ -153318,153 +154450,138 @@ "name": "addTungstenFabricPolicyRule", "params": [ { - "description": "Tungsten-Fabric policy rule source ip prefix", + "description": "Tungsten-Fabric policy rule destination ip prefix", "length": 255, - "name": "srcipprefix", + "name": "destipprefix", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule direction", + "description": "Tungsten-Fabric policy rule destination end port", "length": 255, - "name": "direction", + "name": "destendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination network", + "description": "Tungsten-Fabric policy rule source end port", "length": 255, - "name": "destnetwork", + "name": "srcendport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix", + "description": "Tungsten-Fabric policy rule source network", "length": 255, - "name": "destipprefix", + "name": "srcnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule source end port", + "description": "Tungsten-Fabric policy rule action", "length": 255, - "name": "srcendport", + "name": "action", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source ip prefix length", + "description": "the uuid of Tungsten-Fabric policy", "length": 255, - "name": "srcipprefixlen", + "name": "policyuuid", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination ip prefix length", + "description": "the ID of zone", "length": 255, - "name": "destipprefixlen", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "integer" + "type": "uuid" }, { - "description": "Tungsten-Fabric policy rule destination start port", + "description": "Tungsten-Fabric policy rule source ip prefix length", "length": 255, - "name": "deststartport", + "name": "srcipprefixlen", "required": true, "type": "integer" }, { - "description": "Tungsten-Fabric policy rule source start port", + "description": "Tungsten-Fabric policy rule protocol", "length": 255, - "name": "srcstartport", + "name": "protocol", "required": true, - "type": "integer" + "type": "string" }, { - "description": "Tungsten-Fabric policy rule source network", + "description": "Tungsten-Fabric policy rule destination network", "length": 255, - "name": "srcnetwork", + "name": "destnetwork", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule protocol", + "description": "Tungsten-Fabric policy rule source ip prefix", "length": 255, - "name": "protocol", + "name": "srcipprefix", "required": true, "type": "string" }, { - "description": "the uuid of Tungsten-Fabric policy", + "description": "Tungsten-Fabric policy rule destination start port", "length": 255, - "name": "policyuuid", + "name": "deststartport", "required": true, - "type": "string" + "type": "integer" }, { - "description": "Tungsten-Fabric policy rule action", + "description": "Tungsten-Fabric policy rule direction", "length": 255, - "name": "action", + "name": "direction", "required": true, "type": "string" }, { - "description": "Tungsten-Fabric policy rule destination end port", + "description": "Tungsten-Fabric policy rule destination ip prefix length", "length": 255, - "name": "destendport", + "name": "destipprefixlen", "required": true, "type": "integer" }, { - "description": "the ID of zone", + "description": "Tungsten-Fabric policy rule source start port", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "srcstartport", "required": true, - "type": "uuid" + "type": "integer" } ], "related": "", "response": [ { - "description": "Tungsten-Fabric policy source ip prefix length", - "name": "srcipprefixlen", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy source network", - "name": "srcnetwork", + "description": "Tungsten-Fabric rule uuid", + "name": "uuid", "type": "string" }, { - "description": "Tungsten-Fabric policy destination start port", - "name": "deststartport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination end port", - "name": "destendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy destination network", - "name": "destnetwork", + "description": "Tungsten-Fabric policy protocol", + "name": "protocol", "type": "string" }, { - "description": "Tungsten-Fabric policy uuid", - "name": "policyuuid", + "description": "Tungsten-Fabric policy destination ip prefix", + "name": "destipprefix", "type": "string" }, { - "description": "Tungsten-Fabric rule uuid", - "name": "uuid", + "description": "Tungsten-Fabric provider zone name", + "name": "zonename", "type": "string" }, { - "description": "Tungsten-Fabric policy source start port", - "name": "srcstartport", - "type": "int" + "description": "Tungsten-Fabric policy source network", + "name": "srcnetwork", + "type": "string" }, { "description": "Tungsten-Fabric provider zone id", @@ -153472,35 +154589,46 @@ "type": "long" }, { - "description": "Tungsten-Fabric policy name", - "name": "direction", - "type": "string" + "description": "Tungsten-Fabric policy destination end port", + "name": "destendport", + "type": "int" }, + {}, { - "description": "Tungsten-Fabric policy protocol", - "name": "protocol", + "description": "Tungsten-Fabric policy action", + "name": "action", "type": "string" }, { - "description": "Tungsten-Fabric policy destination ip prefix length", - "name": "destipprefixlen", + "description": "Tungsten-Fabric policy source start port", + "name": "srcstartport", "type": "int" }, { - "description": "Tungsten-Fabric policy source ip prefix", - "name": "srcipprefix", + "description": "Tungsten-Fabric policy uuid", + "name": "policyuuid", "type": "string" }, { - "description": "Tungsten-Fabric provider zone name", - "name": "zonename", + "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 destination ip prefix", - "name": "destipprefix", - "type": "string" + "description": "Tungsten-Fabric policy destination ip prefix length", + "name": "destipprefixlen", + "type": "int" + }, + { + "description": "Tungsten-Fabric policy destination start port", + "name": "deststartport", + "type": "int" }, { "description": "the UUID of the latest async job acting on this object", @@ -153508,20 +154636,24 @@ "type": "string" }, { - "description": "Tungsten-Fabric policy source end port", - "name": "srcendport", - "type": "int" - }, - { - "description": "Tungsten-Fabric policy action", - "name": "action", + "description": "Tungsten-Fabric policy name", + "name": "direction", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" + }, + { + "description": "Tungsten-Fabric policy source ip prefix", + "name": "srcipprefix", + "type": "string" + }, + { + "description": "Tungsten-Fabric policy source ip prefix length", + "name": "srcipprefixlen", + "type": "int" } ] }, @@ -153530,13 +154662,6 @@ "isasync": false, "name": "createWebhook", "params": [ - { - "description": "Description for the Webhook", - "length": 255, - "name": "description", - "required": false, - "type": "string" - }, { "description": "Name for the Webhook", "length": 255, @@ -153559,39 +154684,39 @@ "type": "boolean" }, { - "description": "Secret key of the Webhook", + "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "secretkey", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "Scope of the Webhook", + "description": "An optional account for the Webhook. Must be used with domainId.", "length": 255, - "name": "scope", + "name": "account", "required": false, "type": "string" }, { - "description": "an optional domainId for the Webhook. If the account parameter is used, domainId must also be used.", + "description": "Secret key of the Webhook", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "secretkey", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "An optional account for the Webhook. Must be used with domainId.", + "description": "Scope of the Webhook", "length": 255, - "name": "account", + "name": "scope", "required": false, "type": "string" }, { - "description": "Payload URL of the Webhook", + "description": "Description for the Webhook", "length": 255, - "name": "payloadurl", - "required": true, + "name": "description", + "required": false, "type": "string" }, { @@ -153601,44 +154726,57 @@ "related": "", "required": false, "type": "uuid" + }, + { + "description": "Payload URL of the Webhook", + "length": 255, + "name": "payloadurl", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "The state of the Webhook", - "name": "state", + "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 scope of the Webhook", + "name": "scope", + "type": "string" + }, + { + "description": "The date when this Webhook was created", + "name": "created", + "type": "date" }, { "description": "The payload URL end point for the Webhook", "name": "payloadurl", "type": "string" }, - {}, { - "description": "The name of the Webhook", - "name": "name", - "type": "string" + "description": "Whether SSL verification is enabled for the Webhook", + "name": "sslverification", + "type": "boolean" }, + {}, + {}, { - "description": "The description of the Webhook", - "name": "description", + "description": "the project name of the Kubernetes cluster", + "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 ID of the Webhook", - "name": "id", + "description": "The ID of the domain in which the Webhook exists", + "name": "domainid", "type": "string" }, { @@ -153647,13 +154785,8 @@ "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", + "description": "The account associated with the Webhook", + "name": "account", "type": "string" }, { @@ -153662,25 +154795,24 @@ "type": "string" }, { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "The state of the Webhook", + "name": "state", "type": "string" }, - {}, { - "description": "the project id of the Kubernetes cluster", - "name": "projectid", + "description": "The name of the domain in which the Webhook exists", + "name": "domain", "type": "string" }, { - "description": "The scope of the Webhook", - "name": "scope", + "description": "The description of the Webhook", + "name": "description", "type": "string" }, { - "description": "The name of the domain in which the Webhook 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 to which the Webhook belongs", @@ -153688,9 +154820,9 @@ "type": "string" }, { - "description": "The date when this Webhook was created", - "name": "created", - "type": "date" + "description": "The name of the Webhook", + "name": "name", + "type": "string" } ], "since": "4.20.0" @@ -153700,14 +154832,6 @@ "isasync": true, "name": "removeVpnUser", "params": [ - { - "description": "remove vpn user from the project", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "description": "username for the vpn user", "length": 255, @@ -153715,6 +154839,13 @@ "required": true, "type": "string" }, + { + "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.", "length": 255, @@ -153724,31 +154855,32 @@ "type": "uuid" }, { - "description": "an optional account for the vpn user. Must be used with domainId.", + "description": "remove vpn user from the project", "length": 255, - "name": "account", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "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", "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", @@ -153762,52 +154894,46 @@ "name": "listQuarantinedIps", "params": [ { - "description": "Show IPs that are no longer in quarantine.", + "description": "", "length": 255, - "name": "showinactive", + "name": "page", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "List by keyword", + "description": "Show IPs that are no longer in quarantine.", "length": 255, - "name": "keyword", + "name": "showinactive", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "", + "description": "Show IPs removed from quarantine.", "length": 255, - "name": "pagesize", + "name": "showremoved", "required": false, - "type": "integer" + "type": "boolean" }, { - "description": "Show IPs removed from quarantine.", + "description": "List by keyword", "length": 255, - "name": "showremoved", + "name": "keyword", "required": false, - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "updateQuarantinedIp", "response": [ - {}, - { - "description": "ID of the quarantine process.", - "name": "id", - "type": "string" - }, { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The public IP address in quarantine.", + "name": "ipaddress", "type": "string" }, { @@ -153816,19 +154942,14 @@ "type": "date" }, { - "description": "End date for the quarantine.", - "name": "enddate", - "type": "date" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", "type": "string" }, { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", + "type": "string" }, { "description": "the current status of the latest async job acting on this object", @@ -153836,14 +154957,19 @@ "type": "integer" }, { - "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": "The public IP address in quarantine.", - "name": "ipaddress", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { @@ -153852,10 +154978,16 @@ "type": "string" }, { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", + "description": "End date for the quarantine.", + "name": "enddate", + "type": "date" + }, + { + "description": "ID of the quarantine process.", + "name": "id", "type": "string" - } + }, + {} ], "since": "4.19" }, @@ -153876,13 +155008,8 @@ "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" }, { @@ -153890,12 +155017,17 @@ "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.2.0" }, @@ -153914,7 +155046,7 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, @@ -153928,7 +155060,7 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" } @@ -153936,13 +155068,19 @@ "related": "", "response": [ { - "description": "the Zone ID of the image store", - "name": "zoneid", + "description": "the protocol of the image store", + "name": "protocol", "type": "string" }, { - "description": "the url of the image store", - "name": "url", + "description": "defines if store is read-only", + "name": "readonly", + "type": "boolean" + }, + {}, + { + "description": "the ID of the image store", + "name": "id", "type": "string" }, { @@ -153955,19 +155093,34 @@ "name": "scope", "type": "scopetype" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, { "description": "the host's currently used disk size", "name": "disksizeused", "type": "long" }, { - "description": "the ID of the image store", - "name": "id", + "description": "the Zone ID of the image store", + "name": "zoneid", "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 name of the image store", + "name": "name", "type": "string" }, {}, @@ -153977,35 +155130,14 @@ "type": "boolean" }, { - "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", "type": "string" - }, - { - "description": "the name of the image store", - "name": "name", - "type": "string" - }, - { - "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" @@ -154027,13 +155159,8 @@ "related": "", "response": [ { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the host HA provider", - "name": "haprovider", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -154041,28 +155168,33 @@ "name": "haenable", "type": "boolean" }, + {}, { - "description": "the ID of the host", - "name": "hostid", + "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": "operation status", "name": "status", "type": "boolean" }, { - "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 HA state of the host", "name": "hastate", "type": "hastate" - }, - {} + } ], "since": "4.11" }, @@ -154082,72 +155214,72 @@ ], "related": "", "response": [ - {}, - {}, { - "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": "the out-of-band management interface username", - "name": "username", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, + {}, { "description": "the out-of-band management interface password", "name": "password", "type": "string" }, - { - "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 address", + "name": "address", + "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 ID of the host", - "name": "hostid", + "description": "the out-of-band management interface username", + "name": "username", "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 driver for the host", - "name": "driver", + "description": "the out-of-band management interface port", + "name": "port", "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", + "description": "the out-of-band management action (if issued)", + "name": "action", "type": "string" }, { "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 operation result", + "name": "status", + "type": "boolean" } ], "since": "4.9.0" @@ -154168,11 +155300,7 @@ ], "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", @@ -154183,12 +155311,16 @@ "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" - }, - {} + } ] }, { @@ -154197,20 +155329,18 @@ "name": "listKubernetesSupportedVersions", "params": [ { - "description": "the CPU arch of the binaries ISO. Valid options are: x86_64, aarch64", + "description": "", "length": 255, - "name": "arch", + "name": "pagesize", "required": false, - "since": "4.20", - "type": "string" + "type": "integer" }, { - "description": "the ID of the minimum Kubernetes supported version", + "description": "", "length": 255, - "name": "minimumkubernetesversionid", - "related": "listKubernetesSupportedVersions", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -154219,6 +155349,14 @@ "required": false, "type": "string" }, + { + "description": "the ID of the minimum Kubernetes supported version", + "length": 255, + "name": "minimumkubernetesversionid", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", + "required": false, + "type": "uuid" + }, { "description": "the ID of the zone in which Kubernetes supported version will be available", "length": 255, @@ -154228,18 +155366,20 @@ "type": "uuid" }, { - "description": "", + "description": "the ID of the Kubernetes supported version", "length": 255, - "name": "page", + "name": "id", + "related": "getUploadParamsForKubernetesSupportedVersion,listKubernetesSupportedVersions", "required": false, - "type": "integer" + "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 minimum semantic version for the Kubernetes supported version to be listed", @@ -154247,52 +155387,50 @@ "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": "", + "related": "getUploadParamsForKubernetesSupportedVersion", "response": [ { "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", + "type": "boolean" + }, + { + "description": "Kubernetes semantic version", + "name": "semanticversion", + "type": "string" + }, + {}, { "description": "Name of the Kubernetes supported version", "name": "name", "type": "string" }, { - "description": "the id of the zone in which Kubernetes supported version is available", - "name": "zoneid", + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", "type": "integer" }, { - "description": "the state of the binaries ISO for Kubernetes supported version", - "name": "isostate", - "type": "string" - }, - { - "description": "Kubernetes semantic version", - "name": "semanticversion", + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", "type": "string" }, { - "description": "the enabled or disabled state of the Kubernetes supported version", - "name": "state", - "type": "string" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { "description": "the id of the binaries ISO for Kubernetes supported version", @@ -154301,49 +155439,43 @@ }, {}, { - "description": "whether Kubernetes supported version supports Autoscaling", - "name": "supportsautoscaling", - "type": "boolean" - }, - { - "description": "the id of the Kubernetes supported version", - "name": "id", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "whether Kubernetes supported version supports HA, multi-control nodes", - "name": "supportsha", + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", "type": "boolean" }, { - "description": "the minimum number of CPUs needed for the Kubernetes supported version", - "name": "mincpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, - {}, { - "description": "the name of the binaries ISO for Kubernetes supported version", - "name": "isoname", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the arch of the binaries ISO for Kubernetes supported version", - "name": "arch", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "the name of the zone in which Kubernetes supported version is available", - "name": "zonename", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the date when this Kubernetes supported version was created", - "name": "created", - "type": "date" + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { @@ -154359,17 +155491,10 @@ "name": "addNiciraNvpDevice", "params": [ { - "description": "The Transportzone UUID configured on the Nicira Controller", - "length": 255, - "name": "transportzoneuuid", - "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" }, { @@ -154387,17 +155512,17 @@ "type": "string" }, { - "description": "Credentials to access the Nicira Controller API", + "description": "Hostname of ip address of the Nicira NVP Controller.", "length": 255, - "name": "username", + "name": "hostname", "required": true, "type": "string" }, { - "description": "The L3 Gateway Service UUID configured on the Nicira Controller", + "description": "The Transportzone UUID configured on the Nicira Controller", "length": 255, - "name": "l3gatewayserviceuuid", - "required": false, + "name": "transportzoneuuid", + "required": true, "type": "string" }, { @@ -154407,60 +155532,67 @@ "related": "", "required": true, "type": "uuid" + }, + { + "description": "Credentials to access the Nicira Controller API", + "length": 255, + "name": "username", + "required": true, + "type": "string" } ], "related": "", "response": [ { - "description": "the physical network to which this Nirica Nvp belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "device name", - "name": "niciradevicename", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "this L3 gateway service Uuid", - "name": "l3gatewayserviceuuid", + "description": "the controller Ip address", + "name": "hostname", "type": "string" }, - {}, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device name", + "name": "niciradevicename", "type": "string" }, - { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "device id of the Nicire Nvp", "name": "nvpdeviceid", "type": "string" }, + { + "description": "the transport zone Uuid", + "name": "transportzoneuuid", + "type": "string" + }, { "description": "this L2 gateway service Uuid", "name": "l2gatewayserviceuuid", "type": "string" }, + {}, { - "description": "name of the provider", - "name": "provider", + "description": "this L3 gateway service Uuid", + "name": "l3gatewayserviceuuid", "type": "string" }, + {}, { - "description": "the controller Ip address", - "name": "hostname", + "description": "the physical network to which this Nirica Nvp belongs to", + "name": "physicalnetworkid", "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" } ] @@ -154472,6 +155604,11 @@ "params": [], "related": "", "response": [ + { + "description": "Number of images stores", + "name": "imagestores", + "type": "integer" + }, {}, { "description": "Number of storage pools", @@ -154479,13 +155616,13 @@ "type": "integer" }, { - "description": "Number of images stores", - "name": "imagestores", + "description": "Number of systemvms", + "name": "systemvms", "type": "integer" }, { - "description": "Number of pods", - "name": "pods", + "description": "Number of Alerts", + "name": "alerts", "type": "integer" }, { @@ -154493,29 +155630,19 @@ "name": "hosts", "type": "integer" }, - { - "description": "Number of internal LBs", - "name": "ilbvms", - "type": "integer" - }, { "description": "Number of management servers", "name": "managementservers", "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Number of cpu sockets", - "name": "cpusockets", + "description": "Number of object stores", + "name": "objectstores", "type": "integer" }, { - "description": "Number of Alerts", - "name": "alerts", + "description": "Number of pods", + "name": "pods", "type": "integer" }, { @@ -154529,8 +155656,8 @@ "type": "integer" }, { - "description": "Number of zones", - "name": "zones", + "description": "Number of cpu sockets", + "name": "cpusockets", "type": "integer" }, {}, @@ -154540,13 +155667,23 @@ "type": "integer" }, { - "description": "Number of systemvms", - "name": "systemvms", + "description": "Number of zones", + "name": "zones", "type": "integer" }, { - "description": "Number of object stores", - "name": "objectstores", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "Number of internal LBs", + "name": "ilbvms", + "type": "integer" + }, + { + "description": "Number of backup repositories", + "name": "backuprepositories", "type": "integer" } ], @@ -154558,18 +155695,12 @@ "name": "listUsageRecords", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" - }, - { - "description": "", + "description": "List usage records for the specified account", "length": 255, - "name": "page", + "name": "accountid", + "related": "enableAccount,listAccounts", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "List usage records for specified project", @@ -154579,6 +155710,13 @@ "required": false, "type": "uuid" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "List usage records for the specified domain.", "length": 255, @@ -154590,31 +155728,37 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { - "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.", + "description": "Flag to enable display of Tags for a resource", "length": 255, - "name": "startdate", - "required": true, - "type": "date" + "name": "includetags", + "required": false, + "type": "boolean" }, { - "description": "List usage records for the specified account", + "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", "length": 255, - "name": "accountid", - "related": "enableAccount,listAccounts", + "name": "oldformat", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List usage records for the specified user.", + "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": "account", + "name": "startdate", + "required": true, + "type": "date" + }, + { + "description": "List usage records for the specified usage type", + "length": 255, + "name": "type", "required": false, - "type": "string" + "type": "long" }, { "description": "List usage records for the specified usage UUID. Can be used only together with TYPE parameter.", @@ -154631,62 +155775,54 @@ "type": "date" }, { - "description": "List usage records for the specified usage type", - "length": 255, - "name": "type", - "required": false, - "type": "long" - }, - { - "description": "Flag to enable description rendered in old format which uses internal database IDs instead of UUIDs. False by default.", + "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": "oldformat", + "name": "isrecursive", "required": false, + "since": "4.15", "type": "boolean" }, { - "description": "Flag to enable display of Tags for a resource", + "description": "", "length": 255, - "name": "includetags", + "name": "pagesize", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "Specify if usage records should be fetched recursively per domain. If an account id is passed, records will be limited to that account.", + "description": "List usage records for the specified user.", "length": 255, - "name": "isrecursive", + "name": "account", "required": false, - "since": "4.15", - "type": "boolean" + "type": "string" } ], "related": "", "response": [ { - "description": "the user account name", - "name": "account", + "description": "virtual machine os type ID", + "name": "ostypeid", "type": "string" }, { - "description": "virtual machine os type ID", - "name": "ostypeid", + "description": "the domain the resource is associated with", + "name": "domain", "type": "string" }, { - "description": "end date of the usage record", - "name": "enddate", - "type": "date" + "description": "the project name of the resource", + "name": "project", + "type": "string" }, - {}, { - "description": "the domain ID", - "name": "domainid", + "description": "description of the usage record", + "name": "description", "type": "string" }, { - "description": "resource size", - "name": "size", - "type": "long" + "description": "id of the vpc", + "name": "vpcid", + "type": "string" }, { "description": "virtual machine os category name", @@ -154694,75 +155830,18 @@ "type": "string" }, { - "description": "the project name of the resource", - "name": "project", + "description": "id of the network", + "name": "networkid", "type": "string" }, { - "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 domain associated with the tag", - "name": "domain", - "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": "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 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": "virtual size of resource", + "name": "virtualsize", + "type": "long" }, { - "description": "id of the network", - "name": "networkid", + "description": "offering ID", + "name": "offeringid", "type": "string" }, { @@ -154771,89 +155850,84 @@ "type": "string" }, { - "description": "number of cpu of resource", - "name": "cpunumber", - "type": "long" - }, - { - "description": "description of the usage record", - "name": "description", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "id of the vpc", - "name": "vpcid", + "description": "the project id of the resource", + "name": "projectid", "type": "string" }, { - "description": "the zone ID", - "name": "zoneid", - "type": "string" + "description": "speed of each cpu of resource", + "name": "cpuspeed", + "type": "long" }, { - "description": "raw usage in hours", - "name": "rawusage", + "description": "resource type", + "name": "type", "type": "string" }, { - "description": "True if the resource is default", - "name": "isdefault", - "type": "boolean" + "description": "start date of the usage record", + "name": "startdate", + "type": "date" }, { - "description": "virtual machine guest os category ID", - "name": "oscategoryid", + "description": "path of the domain to which the usage reocrd belongs", + "name": "domainpath", "type": "string" }, { - "description": "usage type ID", - "name": "usagetype", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, - {}, { - "description": "the user account Id", - "name": "accountid", + "description": "resource or virtual machine name", + "name": "name", "type": "string" }, { - "description": "usage in hours", - "name": "usage", + "description": "the zone ID", + "name": "zoneid", "type": "string" }, { - "description": "resource type", - "name": "type", + "description": "the user account name", + "name": "account", "type": "string" }, { - "description": "speed of each cpu of resource", - "name": "cpuspeed", + "description": "resource size", + "name": "size", "type": "long" }, + {}, { - "description": "True if the IPAddress is source NAT", - "name": "issourcenat", + "description": "True if the resource is default", + "name": "isdefault", "type": "boolean" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "memory allocated for the resource", + "name": "memory", + "type": "long" }, { - "description": "virtual size of resource", - "name": "virtualsize", - "type": "long" + "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", + "description": "number of cpu of resource", + "name": "cpunumber", "type": "long" }, { - "description": "resource or virtual machine name", - "name": "name", + "description": "virtual machine guest os category ID", + "name": "oscategoryid", "type": "string" }, { @@ -154862,33 +155936,18 @@ "type": "string" }, { - "description": "the domain the resource is associated with", - "name": "domain", - "type": "string" + "description": "end date of the usage record", + "name": "enddate", + "type": "date" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "True if the IPAddress is source NAT", + "name": "issourcenat", "type": "boolean" }, { - "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", + "description": "the domain ID", + "name": "domainid", "type": "string" }, { @@ -154896,128 +155955,156 @@ "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" - } - ] - }, - { - "description": "Recovers a Destroy volume.", - "isasync": false, - "name": "recoverVolume", - "params": [ - { - "description": "The ID of the volume", - "length": 255, - "name": "id", - "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "required": true, - "type": "uuid" - } - ], - "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", - "response": [ - { - "description": "the project name of the vpn", - "name": "project", - "type": "string" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" - }, - { - "description": "volume uuid that is given by virtualisation provider (only for VMware)", - "name": "externaluuid", - "type": "string" - }, - { - "description": "state of the virtual machine", - "name": "vmstate", - "type": "string" + "description": "the list of resource tags associated", + "name": "tags", + "response": [ + { + "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" + }, + { + "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": "the domain associated with the tag", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "resource type", + "name": "resourcetype", + "type": "string" + }, + { + "description": "tag key name", + "name": "key", + "type": "string" + } + ], + "type": "set" }, { - "description": "name of the disk offering", - "name": "diskofferingname", + "description": "usage in hours", + "name": "usage", "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": "raw usage in hours", + "name": "rawusage", + "type": "string" }, { - "description": "IO requests write rate of the disk volume per the disk offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "the user account Id", + "name": "accountid", + "type": "string" }, + {}, { - "description": "the read (IO) of disk on the vm", - "name": "diskioread", - "type": "long" + "description": "usage type ID", + "name": "usagetype", + "type": "integer" }, { - "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": "Recovers a Destroy volume.", + "isasync": false, + "name": "recoverVolume", + "params": [ { - "description": "max iops of the disk volume", - "name": "maxiops", + "description": "The ID of the volume", + "length": 255, + "name": "id", + "related": "createVolume,recoverVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "required": true, + "type": "uuid" + } + ], + "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", + "response": [ + { + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", "type": "long" }, { - "description": "id of the virtual machine", - "name": "virtualmachineid", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "ID of the snapshot from which this volume was created", + "name": "snapshotid", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", - "type": "boolean" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "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": "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", + "type": "string" }, { "description": "the disk utilization", @@ -155025,32 +156112,32 @@ "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", + "type": "string" }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "type": "string" }, { @@ -155059,8 +156146,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -155069,93 +156156,88 @@ "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name where tag belongs to", + "name": "project", "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": "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 domain associated with the tag", + "name": "domain", "type": "string" } ], "type": "set" }, { - "description": "the project id of the vpn", - "name": "projectid", - "type": "string" + "description": "max iops of the disk volume", + "name": "maxiops", + "type": "long" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, + {}, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", - "type": "string" + "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": "volume uuid that is given by virtualisation provider (only for VMware)", + "name": "externaluuid", "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the format of the disk encryption if applicable", + "name": "encryptformat", "type": "string" }, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "an optional field whether to the display the volume to the end user or not.", - "name": "displayvolume", - "type": "boolean" + "description": "details for the volume repair result, they may vary for different hypervisors", + "name": "volumerepairresult", + "type": "map" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" + "description": "pod id of the volume", + "name": "podid", + "type": "string" }, - {}, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", + "type": "string" }, { "description": "bytes write rate of the disk volume", @@ -155163,78 +156245,78 @@ "type": "long" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "provisioning type used to create volumes.", + "name": "provisioningtype", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "pod id of the volume", - "name": "podid", + "description": "name of the primary storage hosting the disk volume", + "name": "storage", "type": "string" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "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": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the project name of the vpn", + "name": "project", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", - "type": "string" + "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 chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "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", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "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": "ID of the disk volume", - "name": "id", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { @@ -155242,60 +156324,64 @@ "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", + "description": "IO requests read rate of the disk volume per the disk offering", + "name": "diskIopsReadRate", "type": "long" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the status of the volume", + "name": "status", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "id of the virtual machine", + "name": "virtualmachineid", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", - "type": "string" + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", - "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": "the date the disk volume was created", + "name": "created", + "type": "date" }, { - "description": "name of the primary storage hosting the disk volume", - "name": "storage", + "description": "name of the service offering for root disk", + "name": "serviceofferingname", "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 VM's disk write in KiB", - "name": "diskkbswrite", + "description": "display name of the virtual machine", + "name": "vmdisplayname", + "type": "string" + }, + { + "description": "size of the disk volume", + "name": "size", "type": "long" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "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" }, { @@ -155304,54 +156390,105 @@ "type": "string" }, { - "description": "name of the availability zone", - "name": "zonename", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "shared or local storage", - "name": "storagetype", - "type": "string" + "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": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "pod name of the volume", - "name": "podname", + "description": "name of the disk offering", + "name": "diskofferingname", "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 template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "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": "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": "size of the disk volume", - "name": "size", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, + {}, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "description": "state of the virtual machine", + "name": "vmstate", + "type": "string" + }, + { + "description": "the state of the disk volume", + "name": "state", "type": "string" }, { "description": "path of the Domain the disk volume belongs to", "name": "domainpath", "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 volume has delete protection.", + "name": "deleteprotection", + "type": "boolean" + }, + { + "description": "IO requests write rate of the disk volume per the disk offering", + "name": "diskIopsWriteRate", + "type": "long" + }, + { + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", + "type": "string" + }, + { + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", + "type": "string" + }, + { + "description": "type of the virtual machine", + "name": "vmtype", + "type": "string" + }, + { + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" } ], "since": "4.14.0" @@ -155362,19 +156499,19 @@ "name": "removeTungstenFabricNetworkGatewayFromLogicalRouter", "params": [ { - "description": "the ID of zone", + "description": "Tungsten-Fabric logical router uuid", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "logicalrouteruuid", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "Tungsten-Fabric logical router uuid", + "description": "the ID of zone", "length": 255, - "name": "logicalrouteruuid", + "name": "zoneid", + "related": "listZones", "required": true, - "type": "string" + "type": "uuid" }, { "description": "Tungsten-Fabric network uuid", @@ -155392,36 +156529,36 @@ "type": "integer" }, { - "description": "Tungsten-Fabric provider zone id", - "name": "zoneid", - "type": "long" + "description": "list Tungsten-Fabric policy network name", + "name": "network", + "type": "list" }, { "description": "Tungsten-Fabric logical router uuid", "name": "uuid", "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 provider zone name", - "name": "zonename", - "type": "string" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" }, + {}, { "description": "Tungsten-Fabric logical router name", "name": "name", "type": "string" }, - { - "description": "list Tungsten-Fabric policy network name", - "name": "network", - "type": "list" - }, - {}, {} ] }, @@ -155440,10 +156577,17 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, { "description": "the ID of the storage pool", "length": 255, @@ -155455,70 +156599,42 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" - }, - { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "type": "string" } ], "related": "", "response": [ - {}, { - "description": "the full path of the volume", - "name": "fullpath", - "type": "string" - }, - { - "description": "id of the primary storage hosting the volume", - "name": "storageid", + "description": "the format of the volume", + "name": "format", "type": "string" }, { - "description": "type of the primary storage hosting the volume", - "name": "storagetype", + "description": "the full path of the volume", + "name": "fullpath", "type": "string" }, { - "description": "the size of the volume", - "name": "size", - "type": "long" - }, - { - "description": "name of the primary storage hosting the volume", - "name": "storage", + "description": "the path of the volume", + "name": "path", "type": "string" }, - {}, - { - "description": "volume details in key/value pairs.", - "name": "details", - "type": "map" - }, - { - "description": "the virtual size of the volume", - "name": "virtualsize", - "type": "long" - }, { - "description": "the format of the volume", - "name": "format", + "description": "id of the primary storage hosting the volume", + "name": "storageid", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "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 chain info of the volume", + "name": "chaininfo", "type": "string" }, { @@ -155532,14 +156648,35 @@ "type": "string" }, { - "description": "the chain info of the volume", - "name": "chaininfo", + "description": "the size of the volume", + "name": "size", + "type": "long" + }, + { + "description": "volume details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "name of the primary storage hosting the volume", + "name": "storage", "type": "string" }, + {}, { "description": "the encrypt format of the volume", "name": "encryptformat", "type": "string" + }, + { + "description": "type of the primary storage hosting the volume", + "name": "storagetype", + "type": "string" + }, + { + "description": "the virtual size of the volume", + "name": "virtualsize", + "type": "long" } ], "since": "4.19.1" @@ -155550,12 +156687,13 @@ "name": "listZonesMetrics", "params": [ { - "description": "the name of the storage access group", + "description": "the IDs of the zones, mutually exclusive with id", "length": 255, - "name": "storageaccessgroup", + "name": "ids", + "related": "listZones", "required": false, - "since": "4.21.0", - "type": "string" + "since": "4.19.0", + "type": "list" }, { "description": "flag to display the capacity of the zones", @@ -155565,38 +156703,46 @@ "type": "boolean" }, { - "description": "List zones by resource tags (key/value pairs)", + "description": "the network type of the zone that the virtual machine belongs to", "length": 255, - "name": "tags", + "name": "networktype", "required": false, - "since": "4.3", - "type": "map" + "type": "string" }, { - "description": "List by keyword", + "description": "the ID of the zone", "length": 255, - "name": "keyword", + "name": "id", + "related": "listZones", + "required": false, + "type": "uuid" + }, + { + "description": "the name of the storage access group", + "length": 255, + "name": "storageaccessgroup", "required": false, + "since": "4.21.0", "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": "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" }, @@ -155609,20 +156755,19 @@ "type": "uuid" }, { - "description": "the IDs of the zones, mutually exclusive with id", + "description": "List by keyword", "length": 255, - "name": "ids", - "related": "listZones", + "name": "keyword", "required": false, - "since": "4.19.0", - "type": "list" + "type": "string" }, { - "description": "the name of the zone", + "description": "List zones by resource tags (key/value pairs)", "length": 255, - "name": "name", + "name": "tags", "required": false, - "type": "string" + "since": "4.3", + "type": "map" }, { "description": "flag to display the resource image for the zones", @@ -155637,195 +156782,186 @@ "name": "available", "required": false, "type": "boolean" - }, - { - "description": "the ID of the zone", - "length": 255, - "name": "id", - "related": "listZones", - "required": false, - "type": "uuid" } ], "related": "", "response": [ { - "description": "Zone description", - "name": "description", + "description": "the first DNS for the Zone", + "name": "dns1", "type": "string" }, { - "description": "memory allocated disable threshold exceeded", - "name": "memoryallocateddisablethreshold", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's private interfaces", + "name": "routerprivateinterfacemaxmtu", + "type": "integer" }, { - "description": "comma-separated list of storage access groups for the zone", - "name": "storageaccessgroups", - "type": "string" + "description": "true if security groups support is enabled, false otherwise", + "name": "securitygroupsenabled", + "type": "boolean" }, { - "description": "the maximum memory deviation", - "name": "memorymaxdeviation", - "type": "string" + "description": "cpu usage notification threshold exceeded", + "name": "cputhreshold", + "type": "boolean" }, { - "description": "External network provider if any", - "name": "provider", + "description": "Network domain name for the networks in the zone", + "name": "domain", "type": "string" }, { - "description": "the second internal DNS for the Zone", - "name": "internaldns2", + "description": "the total cpu capacity in Ghz", + "name": "cputotal", "type": "string" }, { - "description": "cpu allocated notification threshold exceeded", - "name": "cpuallocatedthreshold", + "description": "memory usage notification threshold exceeded", + "name": "memorythreshold", "type": "boolean" }, { - "description": "cpu usage notification threshold exceeded", - "name": "cputhreshold", - "type": "boolean" + "description": "the total cpu used in Ghz", + "name": "cpuused", + "type": "string" }, { - "description": "the first IPv6 DNS for the Zone", - "name": "ip6dns1", + "description": "Zone description", + "name": "description", "type": "string" }, { - "description": "AS Number Range", - "name": "asnrange", + "description": "the maximum memory deviation", + "name": "memorymaxdeviation", "type": "string" }, { - "description": "the total cpu allocated in GiB", - "name": "memoryallocated", + "description": "comma-separated list of storage access groups for the zone", + "name": "storageaccessgroups", "type": "string" }, { - "description": "the maximum cpu deviation", - "name": "cpumaxdeviation", + "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": "External network provider if any", + "name": "provider", + "type": "string" }, { - "description": "The maximum value the MTU can have on the VR's private interfaces", - "name": "routerprivateinterfacemaxmtu", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", - "type": "string" - }, - { - "description": "the total cpu capacity in GiB", - "name": "memorytotal", + "description": "the second internal DNS for the Zone", + "name": "internaldns2", "type": "string" }, { - "description": "the display text of the zone", - "name": "displaytext", - "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": "cpu allocated disable threshold exceeded", + "name": "cpuallocateddisablethreshold", + "type": "boolean" }, { - "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": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "Meta data associated with the zone (key/value pairs)", + "name": "resourcedetails", + "type": "map" }, { - "description": "Zone name", - "name": "name", + "description": "the second DNS for the Zone", + "name": "dns2", "type": "string" }, { - "description": "Zone Token", - "name": "zonetoken", + "description": "the total cpu allocated in Ghz", + "name": "cpuallocated", "type": "string" }, { - "description": "the list of resource tags associated with zone.", - "name": "tags", + "description": "the capacity of the Zone", + "name": "capacity", "response": [ { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "tag key name", - "name": "key", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "type": "string" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the Pod ID", + "name": "podid", "type": "string" } ], - "type": "set" - }, - { - "description": "true, if zone is NSX enabled", - "name": "isnsxenabled", - "type": "boolean" + "type": "list" }, { "description": "Used GPUs in the Zone", @@ -155833,206 +156969,217 @@ "type": "long" }, { - "description": "the name of the containing domain, null for public zones", - "name": "domainname", + "description": "true if local storage offering enabled, false otherwise", + "name": "localstorageenabled", + "type": "boolean" + }, + { + "description": "the total cpu used in GiB", + "name": "memoryused", "type": "string" }, { - "description": "the network type of the zone; can be Basic or Advanced", - "name": "networktype", + "description": "the total cpu allocated in GiB", + "name": "memoryallocated", "type": "string" }, { - "description": "the total cpu capacity in Ghz", - "name": "cputotal", + "description": "the total cpu capacity in GiB", + "name": "memorytotal", "type": "string" }, { - "description": "true if security groups support is enabled, false otherwise", - "name": "securitygroupsenabled", + "description": "true, if zone contains clusters and hosts from different CPU architectures", + "name": "ismultiarch", "type": "boolean" }, { - "description": "cpu allocated disable threshold exceeded", - "name": "cpuallocateddisablethreshold", - "type": "boolean" + "description": "Zone name", + "name": "name", + "type": "string" }, { - "description": "the dhcp Provider for the Zone", - "name": "dhcpprovider", + "description": "Zone id", + "name": "id", "type": "string" }, { - "description": "memory usage notification threshold exceeded", - "name": "memorythreshold", + "description": "true, if routed network/vpc is enabled", + "name": "routedmodeenabled", "type": "boolean" }, { - "description": "the total cpu allocated in Ghz", - "name": "cpuallocated", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the second IPv6 DNS for the Zone", "name": "ip6dns2", "type": "string" }, + { + "description": "Zone Token", + "name": "zonetoken", + "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", + "type": "string" + }, + { + "description": "cpu allocated notification threshold exceeded", + "name": "cpuallocatedthreshold", + "type": "boolean" + }, + { + "description": "memory usage disable threshold exceeded", + "name": "memorydisablethreshold", + "type": "boolean" + }, + { + "description": "the UUID of the containing domain, null for public zones", + "name": "domainid", + "type": "string" + }, + { + "description": "the name of the containing domain, null for public zones", + "name": "domainname", + "type": "string" + }, + { + "description": "the guest CIDR address for the Zone", + "name": "guestcidraddress", + "type": "string" + }, + { + "description": "cpu usage disable threshold exceeded", + "name": "cpudisablethreshold", + "type": "boolean" + }, { "description": "healthy / total clusters in the zone", "name": "clusters", "type": "string" }, + { + "description": "memory allocated disable threshold exceeded", + "name": "memoryallocateddisablethreshold", + "type": "boolean" + }, + {}, { "description": "the first internal DNS for the Zone", "name": "internaldns1", "type": "string" }, { - "description": "the second DNS for the Zone", - "name": "dns2", + "description": "AS Number Range", + "name": "asnrange", "type": "string" }, { - "description": "the capacity of the Zone", - "name": "capacity", + "description": "the allocation state of the cluster", + "name": "allocationstate", + "type": "string" + }, + {}, + { + "description": "the dhcp Provider for the Zone", + "name": "dhcpprovider", + "type": "string" + }, + { + "description": "the first IPv6 DNS for the Zone", + "name": "ip6dns1", + "type": "string" + }, + { + "description": "the maximum cpu deviation", + "name": "cpumaxdeviation", + "type": "string" + }, + { + "description": "state of the cluster", + "name": "state", + "type": "string" + }, + { + "description": "the list of resource tags associated with zone.", + "name": "tags", "response": [ { - "description": "the Pod ID", - "name": "podid", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" - }, - { - "description": "the capacity type", - "name": "type", - "type": "short" - }, - { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the ID of the domain associated with the tag", + "name": "domainid", + "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" } ], - "type": "list" - }, - { - "description": "Allow end users to specify VR MTU", - "name": "allowuserspecifyvrmtu", - "type": "boolean" - }, - { - "description": "state of the cluster", - "name": "state", - "type": "string" - }, - { - "description": "cpu usage disable threshold exceeded", - "name": "cpudisablethreshold", - "type": "boolean" - }, - { - "description": "the first DNS for the Zone", - "name": "dns1", - "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": "the total cpu used in GiB", - "name": "memoryused", - "type": "string" - }, - { - "description": "The maximum value the MTU can have on the VR's public interfaces", - "name": "routerpublicinterfacemaxmtu", - "type": "integer" - }, - { - "description": "Zone id", - "name": "id", - "type": "string" - }, - { - "description": "true, if zone contains clusters and hosts from different CPU architectures", - "name": "ismultiarch", - "type": "boolean" + "type": "set" }, - {}, { - "description": "memory allocated notification threshold exceeded", - "name": "memoryallocatedthreshold", + "description": "true, if zone is NSX enabled", + "name": "isnsxenabled", "type": "boolean" }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "description": "Network domain name for the networks in the zone", - "name": "domain", - "type": "string" - }, - { - "description": "the guest CIDR address for the Zone", - "name": "guestcidraddress", + { + "description": "the network type of the zone; can be Basic or Advanced", + "name": "networktype", "type": "string" }, { @@ -156041,24 +157188,14 @@ "type": "long" }, { - "description": "true if local storage offering enabled, false otherwise", - "name": "localstorageenabled", - "type": "boolean" + "description": "The maximum value the MTU can have on the VR's public interfaces", + "name": "routerpublicinterfacemaxmtu", + "type": "integer" }, { - "description": "memory usage disable threshold exceeded", - "name": "memorydisablethreshold", + "description": "memory allocated notification threshold exceeded", + "name": "memoryallocatedthreshold", "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" @@ -156069,12 +157206,11 @@ "name": "extractTemplate", "params": [ { - "description": "the ID of the zone where the ISO is originally located", + "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" + "name": "mode", + "required": true, + "type": "string" }, { "description": "the url to which the ISO would be extracted", @@ -156084,105 +157220,106 @@ "type": "string" }, { - "description": "the ID of the template", + "description": "the ID of the zone where the ISO is originally located", "length": 255, - "name": "id", - "related": "registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, + "name": "zoneid", + "related": "listZones", + "required": false, "type": "uuid" }, { - "description": "the mode of extraction - HTTP_DOWNLOAD or FTP_UPLOAD", + "description": "the ID of the template", "length": 255, - "name": "mode", + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,registerTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": true, - "type": "string" + "type": "uuid" } ], "related": "extractSnapshot", "response": [ { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "the id of extracted object", + "name": "id", "type": "string" }, { - "description": "the time and date the object was created", - "name": "created", - "type": "date" + "description": "the account id to which the extracted object belongs", + "name": "accountid", + "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", + "description": "", + "name": "resultstring", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the name of the extracted object", + "name": "name", + "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the time and date the object was created", + "name": "created", + "type": "date" + }, + { + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "zone ID the object was extracted from", - "name": "zoneid", + "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": "type of the storage", + "name": "storagetype", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "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": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, - {}, { "description": "the percentage of the entity uploaded to the specified location", "name": "uploadpercentage", "type": "integer" }, { - "description": "the id of extracted object", - "name": "id", + "description": "the state of the extracted object", + "name": "state", "type": "string" }, { - "description": "type of the storage", - "name": "storagetype", + "description": "the status of the extraction", + "name": "status", "type": "string" }, { - "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 name of the extracted object", - "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 extracted object", - "name": "state", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, - { - "description": "zone name the object was extracted from", - "name": "zonename", - "type": "string" - } + {} ] }, { @@ -156194,18 +157331,22 @@ "description": "The ID of the virtual machine", "length": 255, "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", + "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,createVMFromBackup,importVm", "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", "type": "string" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -156217,11 +157358,7 @@ "type": "boolean" }, {}, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - } + {} ] }, { @@ -156230,12 +157367,12 @@ "name": "updateIpAddress", "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 IP 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 public IP address to update", @@ -156246,50 +157383,54 @@ "type": "uuid" }, { - "description": "an optional field, whether to the display the IP 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": "associateIpAddress,listPublicIpAddresses", "response": [ { - "description": "the domain the public IP address is associated with", - "name": "domain", + "description": "public IP address", + "name": "ipaddress", "type": "string" }, { - "description": "true if range is dedicated for external network providers", - "name": "forprovider", - "type": "boolean" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "the virtual network for the IP address", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "the ID of the Network associated with the IP address", + "name": "associatednetworkid", + "type": "string" }, { - "description": "public IP address id", - "name": "id", + "description": "the name of the zone the public IP address belongs to", + "name": "zonename", "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": "virtual machine name the ip address is assigned to", - "name": "virtualmachinename", + "description": "the name of the Network associated with the IP address", + "name": "associatednetworkname", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", + "description": "true if range is dedicated for System VMs", + "name": "forsystemvms", + "type": "boolean" + }, + { + "description": "the name of the Network where ip belongs to", + "name": "networkname", "type": "string" }, { @@ -156297,25 +157438,40 @@ "name": "vpcname", "type": "string" }, + { + "description": "the virtual network for the IP address", + "name": "forvirtualnetwork", + "type": "boolean" + }, {}, { - "description": "virtual machine display name the ip address is assigned to (not null only for static nat Ip)", - "name": "virtualmachinedisplayname", + "description": "VPC id the ip belongs to", + "name": "vpcid", "type": "string" }, { - "description": "the ID of the Network associated with the IP address", - "name": "associatednetworkid", + "description": "the ID of the Network where ip belongs to", + "name": "networkid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "virtual machine type the ip address is assigned to", + "name": "virtualmachinetype", "type": "string" }, { - "description": "the ID of the VLAN associated with the IP address. This parameter is visible to ROOT admins only", - "name": "vlanid", + "description": "virtual machine name the ip address is assigned to", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "true if the IP address is a source nat address, false otherwise", + "name": "issourcenat", + "type": "boolean" + }, + { + "description": "public IP address id", + "name": "id", "type": "string" }, { @@ -156328,8 +157484,13 @@ "name": "tags", "response": [ { - "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" }, { @@ -156338,8 +157499,13 @@ "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", "type": "string" }, { @@ -156353,8 +157519,8 @@ "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" }, { @@ -156368,36 +157534,32 @@ "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", + "description": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "list" }, { - "description": "the account the public IP address is associated with", - "name": "account", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + {}, + { + "description": "the VLAN associated with the IP address", + "name": "vlanname", "type": "string" }, { - "description": "path of the domain to which the public IP address belongs", - "name": "domainpath", + "description": "the domain the public IP address is associated with", + "name": "domain", "type": "string" }, { - "description": "true if the IP address is a source nat address, false otherwise", - "name": "issourcenat", + "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", + "name": "hasrules", "type": "boolean" }, { @@ -156405,100 +157567,80 @@ "name": "zoneid", "type": "string" }, - { - "description": "VPC id the ip 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", + "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", + "description": "true if range is dedicated for external network providers", + "name": "forprovider", "type": "boolean" }, { - "description": "the ID of the Network where ip belongs to", - "name": "networkid", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "date the public IP address was acquired", - "name": "allocated", - "type": "date" - }, - { - "description": "is public ip for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the domain ID the public IP address is associated with", - "name": "domainid", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "whether the ip address has Firewall/PortForwarding/LoadBalancing rules defined", - "name": "hasrules", - "type": "boolean" - }, - { - "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", - "name": "vmipaddress", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "true if range is dedicated for System VMs", - "name": "forsystemvms", + "description": "is public IP portable across the zones", + "name": "isportable", "type": "boolean" }, { - "description": "public IP address", - "name": "ipaddress", + "description": "the account the public IP address is associated with", + "name": "account", "type": "string" }, { - "description": "the VLAN associated with the IP address", - "name": "vlanname", + "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": "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 domain ID the public IP address is associated with", + "name": "domainid", "type": "string" }, { - "description": "the name of the Network associated with the IP address", - "name": "associatednetworkname", + "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 entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "virtual machine (dnat) ip address (not null only for static nat Ip)", + "name": "vmipaddress", + "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": "the name of the Network where ip belongs to", - "name": "networkname", + "description": "path of the domain to which the public IP address belongs", + "name": "domainpath", "type": "string" }, { - "description": "the name of the zone the public IP address belongs to", - "name": "zonename", - "type": "string" + "description": "is public ip for display to the regular user", + "name": "fordisplay", + "type": "boolean" }, { "description": "virtual machine id the ip address is assigned to", @@ -156506,13 +157648,8 @@ "type": "string" }, { - "description": "virtual machine type the ip address is assigned to", - "name": "virtualmachinetype", - "type": "string" - }, - { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "State of the ip address. Can be: Allocating, Allocated, Releasing, Reserved and Free", + "name": "state", "type": "string" } ] @@ -156522,13 +157659,6 @@ "isasync": true, "name": "migrateNetwork", "params": [ - { - "description": "true if previous network migration cmd failed", - "length": 255, - "name": "resume", - "required": false, - "type": "boolean" - }, { "description": "the ID of the network", "length": 255, @@ -156537,6 +157667,13 @@ "required": true, "type": "uuid" }, + { + "description": "true if previous network migration cmd failed", + "length": 255, + "name": "resume", + "required": false, + "type": "boolean" + }, { "description": "network offering ID", "length": 255, @@ -156549,173 +157686,163 @@ "related": "createNetwork,updateNetwork,listNetworks", "response": [ { - "description": "The Ipv6 routing type of network offering", - "name": "ip6routing", + "description": "the ID of the Network associated with this private gateway", + "name": "associatednetworkid", "type": "string" }, { - "description": "the name of the network", - "name": "name", + "description": "the first IPv6 DNS for the network", + "name": "ip6dns1", "type": "string" }, { - "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", - "name": "broadcasturi", - "type": "string" + "description": "true if network is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "The IPv4 routing type of network", - "name": "ip4routing", + "description": "the type of the network", + "name": "type", "type": "string" }, { - "description": "ACL Id associated with the VPC network", - "name": "aclid", + "description": "the project id of the ipaddress", + "name": "projectid", "type": "string" }, { - "description": "path of the Domain the network belongs to", - "name": "domainpath", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "VPC the network belongs to", - "name": "vpcid", + "description": "the physical network id", + "name": "physicalnetworkid", "type": "string" }, { - "description": "related to what other network configuration", - "name": "related", + "description": "name of the network offering the network is created from", + "name": "networkofferingname", "type": "string" }, { - "description": "the second IPv6 DNS for the network", - "name": "ip6dns2", + "description": "zone id of the network", + "name": "zoneid", "type": "string" }, { - "description": "the first IPv6 DNS for the network", - "name": "ip6dns1", + "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": "the id of the network", + "name": "id", + "type": "string" }, { - "description": "The vlan of the network. This parameter is visible to ROOT admins only", - "name": "vlan", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the date this network was created", - "name": "created", - "type": "date" + "description": "Name of the VPC to which this network belongs", + "name": "vpcname", + "type": "string" }, { - "description": "the name of the Network associated with this private gateway", - "name": "associatednetwork", + "description": "The Ipv6 routing type of network offering", + "name": "ip6routing", "type": "string" }, { - "description": "the displaytext of the network", - "name": "displaytext", + "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 owner of the network", - "name": "account", + "description": "the name of the zone the network belongs to", + "name": "zonename", "type": "string" }, { - "description": "true if network is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "The routes for the network to ease adding route in upstream router", + "name": "ip4routes", + "type": "set" }, { - "description": "the domain name of the network owner", - "name": "domain", + "description": "path of the Domain the network belongs to", + "name": "domainpath", "type": "string" }, { - "description": "zone id of the network", - "name": "zoneid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the physical network id", - "name": "physicalnetworkid", + "description": "related to what other network configuration", + "name": "related", "type": "string" }, { - "description": "true if network supports specifying vlan, false otherwise", - "name": "specifyvlan", - "type": "boolean" + "description": "AS NUMBER", + "name": "asnumber", + "type": "long" }, { - "description": "list networks available for vm deployment", - "name": "canusefordeploy", - "type": "boolean" + "description": "the owner of the network", + "name": "account", + "type": "string" }, { - "description": "the network's gateway", - "name": "gateway", + "description": "ACL Id associated with the VPC network", + "name": "aclid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "type": "string" + "description": "true network requires restart", + "name": "restartrequired", + "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "MTU configured on the network VR's private interfaces", + "name": "privatemtu", "type": "integer" }, { - "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 domain id of the network owner", - "name": "domainid", - "type": "string" + "description": "true if network supports specifying ip ranges, false otherwise", + "name": "specifyipranges", + "type": "boolean" }, { - "description": "the first IPv4 DNS for the network", - "name": "dns1", + "description": "the second IPv4 DNS for the network", + "name": "dns2", "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "description": "availability of the network offering the network is created from", + "name": "networkofferingavailability", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, - { - "description": "acl type - access type to the network", - "name": "acltype", + "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", + "name": "cidr", "type": "string" }, { - "description": "If the network has redundant routers enabled", - "name": "redundantrouter", - "type": "boolean" - }, - { - "description": "the network's netmask", - "name": "netmask", + "description": "broadcast uri of the network. This parameter is visible to ROOT admins only", + "name": "broadcasturi", "type": "string" }, { - "description": "Broadcast domain type of the network", - "name": "broadcastdomaintype", + "description": "ACL name associated with the VPC network", + "name": "aclname", "type": "string" }, { @@ -156724,24 +157851,9 @@ "type": "string" }, { - "description": "true if network supports specifying ip ranges, false otherwise", - "name": "specifyipranges", - "type": "boolean" - }, - { - "description": "true if guest network default egress policy is allow; false if default egress policy is deny", - "name": "egressdefaultpolicy", - "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": "the date this network was created", + "name": "created", + "type": "date" }, { "description": "The routes for the network to ease adding route in upstream router", @@ -156749,49 +157861,54 @@ "type": "set" }, { - "description": "the details of the network", - "name": "details", - "type": "map" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "Name of the VPC to which this network belongs", - "name": "vpcname", + "description": "the name of the Network associated with this private gateway", + "name": "associatednetwork", "type": "string" }, { - "description": "true if network can span multiple zones", - "name": "strechedl2subnet", - "type": "boolean" + "description": "the name of the network", + "name": "name", + "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "MTU configured on the network VR's public facing interfaces", + "name": "publicmtu", + "type": "integer" }, { - "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": "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 network supports specifying vlan, false otherwise", + "name": "specifyvlan", + "type": "boolean" }, { - "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 IP range not to be used by CloudStack guest VMs and can be used for non CloudStack purposes", - "name": "reservediprange", + "description": "true if network offering is ip conserve mode enabled", + "name": "networkofferingconservemode", + "type": "boolean" + }, + { + "description": "UUID of AS NUMBER", + "name": "asnumberid", "type": "string" }, { - "description": "true if network is system, false otherwise", - "name": "issystem", - "type": "boolean" + "description": "acl type - access type to the network", + "name": "acltype", + "type": "string" }, { "description": "the traffic type of the network", @@ -156799,119 +157916,110 @@ "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 gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" }, { - "description": "display text of the network offering the network is created from", - "name": "networkofferingdisplaytext", + "description": "the project name of the address", + "name": "project", "type": "string" }, { - "description": "The routes for the network to ease adding route in upstream router", - "name": "ip4routes", - "type": "set" + "description": "list networks available for vm deployment", + "name": "canusefordeploy", + "type": "boolean" }, { - "description": "UUID of AS NUMBER", - "name": "asnumberid", - "type": "string" + "description": "true if network is system, false otherwise", + "name": "issystem", + "type": "boolean" }, { - "description": "the list of services", - "name": "service", + "description": "the list of resource tags associated with network", + "name": "tags", "response": [ { - "description": "the service provider name", - "name": "provider", - "response": [ - { - "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": "state of the network provider", - "name": "state", - "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" - } - ], - "type": "list" + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" }, { - "description": "the service name", - "name": "name", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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 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": "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": "the project name where tag belongs to", + "name": "project", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "list" }, { - "description": "true if network offering is ip conserve mode enabled", - "name": "networkofferingconservemode", + "description": "Broadcast domain type of the network", + "name": "broadcastdomaintype", + "type": "string" + }, + { + "description": "an optional field, whether to the display the network to the end user or not.", + "name": "displaynetwork", "type": "boolean" }, { - "description": "the second IPv4 DNS for the network", - "name": "dns2", - "type": "string" + "description": "if network offering supports vm autoscaling feature", + "name": "supportsvmautoscaling", + "type": "boolean" }, { - "description": "the id of the network", - "name": "id", + "description": "The IPv4 routing type of network", + "name": "ip4routing", "type": "string" }, { - "description": "availability of the network offering the network is created from", - "name": "networkofferingavailability", + "description": "the second IPv6 DNS for the network", + "name": "ip6dns2", "type": "string" }, { @@ -156920,18 +158028,28 @@ "type": "boolean" }, { - "description": "The internet protocol of network offering", - "name": "internetprotocol", - "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", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "list networks that are persistent", + "name": "ispersistent", + "type": "boolean" + }, + { + "description": "Tungsten-Fabric virtual router the network belongs to", + "name": "tungstenvirtualrouteruuid", "type": "string" }, { - "description": "the project name of the address", - "name": "project", + "description": "The vlan of the network. This parameter is visible to ROOT admins only", + "name": "vlan", "type": "string" }, { @@ -156940,138 +158058,157 @@ "type": "set" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" - }, - { - "description": "Cloudstack managed address space, all CloudStack managed VMs get IP address from CIDR", - "name": "cidr", + "description": "the domain id of the network owner", + "name": "domainid", "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", + "description": "true if network can span multiple zones", + "name": "strechedl2subnet", "type": "boolean" }, + {}, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" + "description": "the network's netmask", + "name": "netmask", + "type": "string" }, { - "description": "true network requires restart", - "name": "restartrequired", - "type": "boolean" + "description": "the network's gateway", + "name": "gateway", + "type": "string" }, - {}, { - "description": "state of the network", - "name": "state", + "description": "the first IPv4 DNS for the network", + "name": "dns1", "type": "string" }, { - "description": "the ID of the Network associated with this private gateway", - "name": "associatednetworkid", - "type": "string" + "description": "the details of the network", + "name": "details", + "type": "map" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "If the network has redundant routers enabled", + "name": "redundantrouter", "type": "boolean" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The internet protocol of network offering", + "name": "internetprotocol", "type": "string" }, {}, { - "description": "name of the network offering the network is created from", - "name": "networkofferingname", + "description": "true if guest network default egress policy is allow; false if default egress policy is deny", + "name": "egressdefaultpolicy", + "type": "boolean" + }, + { + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "AS NUMBER", - "name": "asnumber", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the list of resource tags associated with network", - "name": "tags", + "description": "the list of services", + "name": "service", "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": "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" }, { - "description": "tag value", - "name": "value", + "description": "the service name", + "name": "name", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", - "type": "string" + "description": "the service provider name", + "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", + "type": "string" + }, + { + "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" + }, + { + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" + } + ], + "type": "list" } ], "type": "list" }, { - "description": "list networks that are persistent", - "name": "ispersistent", - "type": "boolean" + "description": "the domain name of the network owner", + "name": "domain", + "type": "string" + }, + { + "description": "VPC the network belongs to", + "name": "vpcid", + "type": "string" + }, + { + "description": "state of the network", + "name": "state", + "type": "string" } ], "since": "4.11.0" @@ -157082,11 +158219,11 @@ "name": "listUnmanagedInstances", "params": [ { - "description": "the hypervisor name of the instance", + "description": "", "length": 255, - "name": "name", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { "description": "", @@ -157095,6 +158232,13 @@ "required": false, "type": "integer" }, + { + "description": "the hypervisor name of the instance", + "length": 255, + "name": "name", + "required": false, + "type": "string" + }, { "description": "the cluster ID", "length": 255, @@ -157104,137 +158248,167 @@ "type": "uuid" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, + "type": "string" + } + ], + "related": "", + "response": [ + { + "description": "the CPU cores per socket for the virtual machine. VMware specific", + "name": "cpucorepersocket", "type": "integer" }, { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, + "description": "the CPU cores of the virtual machine", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "the name of the host to which virtual machine belongs", + "name": "hostname", + "type": "string" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the cluster to which virtual machine belongs", + "name": "clustername", "type": "string" }, { - "description": "the CPU cores per socket for the virtual machine. VMware specific", - "name": "cpucorepersocket", + "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": "indicates the boot mode", "name": "bootmode", "type": "string" }, { - "description": "the list of disks associated with the virtual machine", - "name": "disk", + "description": "the power state of the virtual machine", + "name": "powerstate", + "type": "string" + }, + { + "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 controller of the disk", - "name": "controller", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the position of the disk", - "name": "position", + "description": "MTU configured on the NIC", + "name": "mtu", "type": "integer" }, { - "description": "the controller of the disk", - "name": "datastorepath", - "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": "the name of the corresponding network", + "name": "networkname", + "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorehost", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the ID of the disk", - "name": "id", + "description": "the traffic type of the nic", + "name": "traffictype", "type": "string" }, { - "description": "the file path of the disk image", - "name": "imagepath", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "the label of the disk", - "name": "label", + "description": "the ID of the corresponding network", + "name": "networkid", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastoretype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "the controller of the disk", - "name": "datastorename", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", + "type": "list" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" - } - ], - "type": "set" - }, - { - "description": "the list of nics associated with the virtual machine", - "name": "nic", - "response": [ + }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the ID of the nic", + "name": "id", "type": "string" }, + { + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "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 isolated private VLAN type if available", "name": "isolatedpvlantype", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "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": "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 ID of the nic", - "name": "id", + "description": "the netmask of the nic", + "name": "netmask", "type": "string" }, { @@ -157242,164 +158416,142 @@ "name": "ip6address", "type": "string" }, + { + "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 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 netmask of the nic", - "name": "netmask", + "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 ip address of the nic", + "name": "ipaddress", + "type": "string" }, { "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": "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": "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": "the traffic type of the nic", - "name": "traffictype", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" - }, + } + ], + "type": "set" + }, + { + "description": "indicates the boot type", + "name": "boottype", + "type": "string" + }, + { + "description": "the ID of the host to which virtual machine belongs", + "name": "hostid", + "type": "string" + }, + {}, + { + "description": "the name of the virtual machine", + "name": "name", + "type": "string" + }, + { + "description": "the list of disks associated with the virtual machine", + "name": "disk", + "response": [ { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the controller of the disk", + "name": "controller", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", - "type": "string" + "description": "the controller unit of the disk", + "name": "controllerunit", + "type": "integer" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the controller of the disk", + "name": "datastorepath", "type": "string" }, { - "description": "the type of the nic", - "name": "type", - "type": "string" + "description": "the capacity of the disk in bytes", + "name": "capacity", + "type": "long" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the label of the disk", + "name": "label", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the controller of the disk", + "name": "datastoretype", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the controller of the disk", + "name": "datastorename", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the ID of the disk", + "name": "id", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", + "description": "the position of the disk", + "name": "position", "type": "integer" }, { - "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" + "description": "the file path of the disk image", + "name": "imagepath", + "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the controller of the disk", + "name": "datastorehost", "type": "string" } ], "type": "set" }, { - "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 name of the cluster to which virtual machine belongs", - "name": "clustername", - "type": "string" - }, - { - "description": "the CPU cores of the virtual machine", - "name": "cpunumber", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "indicates the boot type", - "name": "boottype", - "type": "string" - }, - { - "description": "the power state of the virtual machine", - "name": "powerstate", - "type": "string" - }, - { - "description": "the name of the host to which virtual machine belongs", - "name": "hostname", + "description": "the ID of the cluster to which virtual machine belongs", + "name": "clusterid", "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", @@ -157407,23 +158559,8 @@ }, {}, { - "description": "the ID of the cluster to which virtual machine belongs", - "name": "clusterid", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" - }, - { - "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", + "description": "the memory of the virtual machine in MB", + "name": "memory", "type": "integer" } ], @@ -157435,40 +158572,24 @@ "name": "registerTemplate", "params": [ { - "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "description": "true if template contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "directdownload", + "name": "isdynamicallyscalable", "required": false, "type": "boolean" }, { - "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", + "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": "arch", + "name": "checksum", "required": false, - "since": "4.20", "type": "string" }, { - "description": "true if the template supports the password reset feature; default is false", - "length": 255, - "name": "passwordenabled", - "required": false, - "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. ", - "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.", + "description": "Register template for the project", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, @@ -157481,91 +158602,85 @@ "type": "boolean" }, { - "description": "true if this template is a featured template, false otherwise", + "description": "the target hypervisor for the template", "length": 255, - "name": "isfeatured", - "required": false, - "type": "boolean" + "name": "hypervisor", + "required": true, + "type": "string" }, { - "description": "Template details in key/value pairs using format details[i].keyname=keyvalue. Example: details[0].hypervisortoolsversion=xenserver61", + "description": "the CPU arch of the template. Valid options are: x86_64, aarch64", "length": 255, - "name": "details", + "name": "arch", "required": false, - "type": "map" + "since": "4.20", + "type": "string" }, { - "description": "true if the template type is routing i.e., if template is used to deploy router", + "description": "true if the template or its derivatives are extractable; default is false", "length": 255, - "name": "isrouting", + "name": "isextractable", "required": false, "type": "boolean" }, { - "description": "ID of the extension", + "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "externaldetails", "required": false, "since": "4.21.0", - "type": "uuid" + "type": "map" }, { - "description": "the target hypervisor for the template", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "isrouting", + "required": false, + "type": "boolean" }, { - "description": "Register template for the project", + "description": "the tag for this template.", "length": 255, - "name": "projectid", - "related": "", + "name": "templatetag", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "true if this template requires HVM", + "description": "if true, the templates would be available for deploying CKS clusters", "length": 255, - "name": "requireshvm", + "name": "forcks", "required": false, + "since": "4.21.0", "type": "boolean" }, { - "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", - "length": 255, - "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).", + "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": "templatetype", + "name": "ostypeid", + "related": "", "required": false, - "since": "4.19.0", - "type": "string" + "type": "uuid" }, { - "description": "32 or 64 bits support. 64 by default", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "bits", + "name": "sshkeyenabled", "required": false, - "type": "integer" + "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": "ID of the extension", "length": 255, - "name": "ostypeid", - "related": "", + "name": "extensionid", + "related": "listExtensions", "required": false, + "since": "4.21.0", "type": "uuid" }, { - "description": "the URL of where the template is hosted. Possible URL include http:// and https://", - "length": 2048, - "name": "url", + "description": "the format for the template. Possible values include QCOW2, RAW, VHD and OVA.", + "length": 255, + "name": "format", "required": true, "type": "string" }, @@ -157576,20 +158691,6 @@ "required": true, "type": "string" }, - { - "description": "true if the template or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", - "required": false, - "type": "boolean" - }, - { - "description": "true if the template supports the sshkey upload feature; default is false", - "length": 255, - "name": "sshkeyenabled", - "required": false, - "type": "boolean" - }, { "description": "the ID of the zone the template is to be hosted on", "length": 255, @@ -157613,12 +158714,25 @@ "type": "string" }, { - "description": "if true, the templates would be available for deploying CKS clusters", + "description": "32 or 64 bits support. 64 by default", "length": 255, - "name": "forcks", + "name": "bits", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" + }, + { + "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": "an optional accountName. Must be used with domainId.", @@ -157628,152 +158742,145 @@ "type": "string" }, { - "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", + "description": "the type of the template. Valid options are: USER/VNF (for all users) and SYSTEM/ROUTING/BUILTIN (for admins only).", "length": 255, - "name": "externaldetails", + "name": "templatetype", "required": false, - "since": "4.21.0", - "type": "map" + "since": "4.19.0", + "type": "string" }, { - "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" + "type": "uuid" }, { - "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": "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": "checksum", + "name": "zoneids", + "related": "listZones", "required": false, - "type": "string" + "type": "list" }, { - "description": "the tag for this template.", + "description": "true if this template requires HVM", "length": 255, - "name": "templatetag", + "name": "requireshvm", "required": false, - "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" + "type": "boolean" }, { - "description": "the account name to which the template belongs", - "name": "account", - "type": "string" + "description": "true if this template is a featured template, false otherwise", + "length": 255, + "name": "isfeatured", + "required": false, + "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", + "description": "true if the template supports the password reset feature; default is false", + "length": 255, + "name": "passwordenabled", + "required": false, "type": "boolean" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", - "type": "string" - }, + "description": "true if template should bypass Secondary Storage and be downloaded to Primary Storage on deployment", + "length": 255, + "name": "directdownload", + "required": false, + "type": "boolean" + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { - "description": "checksum of the template", - "name": "checksum", + "description": "the project id of the template", + "name": "projectid", "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 OS type for this template.", - "name": "ostypeid", + "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 tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the template name", - "name": "name", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the status of the template", - "name": "status", + "description": "the ID of the domain to which the template belongs", + "name": "domainid", "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", + "type": "boolean" }, { - "description": "the template ID of the parent template if present", - "name": "sourcetemplateid", + "description": "the type of the template", + "name": "templatetype", "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": "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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", + "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "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": "path of the Domain the template belongs to", + "name": "domainpath", + "type": "string" }, { - "description": "the template ID", - "name": "id", + "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": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "description": "the template display text", + "name": "displaytext", + "type": "string" }, { "description": "the list of resource tags associated", @@ -157795,23 +158902,23 @@ "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -157820,8 +158927,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { @@ -157830,47 +158937,88 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], "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 processor bit size", + "name": "bits", + "type": "int" + }, + { + "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": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "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 ID of the secondary storage host for the template", - "name": "hostid", - "type": "string" + "description": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" }, + {}, { - "description": "the template display text", - "name": "displaytext", - "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": "CPU Arch of the template", + "name": "arch", "type": "string" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "the size of the template", - "name": "size", - "type": "long" + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", + "type": "boolean" + }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" }, { "description": "true if the template is ready to be deployed from, false otherwise.", @@ -157878,8 +159026,8 @@ "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", + "description": "the template ID", + "name": "id", "type": "string" }, { @@ -157888,25 +159036,36 @@ "type": "boolean" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "checksum of the template", + "name": "checksum", "type": "string" }, { - "description": "true if template requires HVM enabled, false otherwise", - "name": "requireshvm", - "type": "boolean" + "description": "the status of the template", + "name": "status", + "type": "string" }, + {}, { - "description": "true if the ISO is bootable, false otherwise", - "name": "bootable", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", "type": "boolean" }, { - "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 date this template was removed", + "name": "removed", + "type": "date" + }, { "description": "the account id to which the template belongs", "name": "accountid", @@ -157918,61 +159077,39 @@ "type": "long" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", - "type": "string" - }, - { - "description": "the name of the zone for this template", - "name": "zonename", - "type": "string" - }, - { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "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", - "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 to which the template belongs", - "name": "domainid", + "description": "the URL which the template/iso is registered from", + "name": "url", "type": "string" }, { - "description": "the processor bit size", - "name": "bits", - "type": "int" - }, - { - "description": "true if the template is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - {}, - { - "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": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", - "type": "map" + "description": "the format of the template.", + "name": "format", + "type": "imageformat" }, - {}, { - "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", - "type": "boolean" + "description": "the name of the domain to which the template belongs", + "name": "domain", + "type": "string" }, { "description": "the name of userdata linked to this template", @@ -157980,39 +159117,39 @@ "type": "string" }, { - "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", + "type": "boolean" }, { - "description": "the project name of the template", - "name": "project", + "description": "the id of userdata linked to this template", + "name": "userdataid", "type": "string" }, { - "description": "the date this template was removed", - "name": "removed", - "type": "date" + "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", + "description": "true if the template is extractable, false otherwise", + "name": "isextractable", "type": "boolean" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", + "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": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" }, { - "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" } ] }, @@ -158022,90 +159159,77 @@ "name": "listVnfAppliances", "params": [ { - "description": "the ID of the virtual machine", - "length": 255, - "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 vms by vpc", + "description": "the security group ID", "length": 255, - "name": "vpcid", - "related": "createVPC,listVPCs,updateVPC", + "name": "securitygroupid", + "related": "", "required": false, + "since": "4.15", "type": "uuid" }, { - "description": "The ID of the Orchestrator extension for the VM", + "description": "the user ID that created the VM and is under the account that owns the VM", "length": 255, - "name": "extensionid", - "related": "listExtensions", + "name": "userid", + "related": "getUser", "required": false, - "since": "4.21.0", "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": "list objects by project; if projectid=-1 lists All VMs", + "description": "list by the backup offering", "length": 255, - "name": "projectid", + "name": "backupofferingid", "related": "", "required": false, + "since": "4.17", "type": "uuid" }, { - "description": "the ID of AutoScaling VM Group", + "description": "the availability zone ID", "length": 255, - "name": "autoscalevmgroupid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.18.0", "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.", - "length": 255, - "name": "details", - "required": false, - "type": "list" - }, - { - "description": "the instances by userdata", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "userdataid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.20.1", "type": "uuid" }, { - "description": "list vms by iso", + "description": "the ID of AutoScaling VM Group", "length": 255, - "name": "isoid", + "name": "autoscalevmgroupid", + "related": "", "required": false, + "since": "4.18.0", "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": "list resources by display flag; only ROOT admin is eligible to pass this parameter", "length": 255, - "name": "state", + "name": "displayvm", "required": false, - "type": "string" + "since": "4.4", + "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.", + "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": "isvnf", + "name": "gpuenabled", "required": false, - "since": "4.19.0", + "since": "4.21.0", "type": "boolean" }, { @@ -158124,28 +159248,34 @@ "type": "boolean" }, { - "description": "list resources by display flag; only ROOT admin is eligible to pass this parameter", + "description": "list vms by ssh keypair name", "length": 255, - "name": "displayvm", + "name": "keypair", "required": false, - "since": "4.4", - "type": "boolean" + "type": "string" }, { - "description": "list vms by template", + "description": "", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the target hypervisor for the template", + "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": "hypervisor", + "name": "state", "required": false, "type": "string" }, + { + "description": "list vms by affinity group", + "length": 255, + "name": "affinitygroupid", + "related": "", + "required": false, + "type": "uuid" + }, { "description": "CPU arch of the VM", "length": 255, @@ -158155,62 +159285,73 @@ "type": "string" }, { - "description": "flag to display the resource icon for 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": "showicon", + "name": "name", "required": false, - "since": "4.16.0.0", - "type": "boolean" + "type": "string" }, { - "description": "", + "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": "page", + "name": "isvnf", "required": false, - "type": "integer" + "since": "4.19.0", + "type": "boolean" }, { - "description": "the IDs of the virtual machines, mutually exclusive with id", + "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": "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", + "name": "details", "required": false, - "since": "4.4", "type": "list" }, { - "description": "the security group ID", + "description": "list vms by vpc", "length": 255, - "name": "securitygroupid", - "related": "", + "name": "vpcid", + "related": "createVPC,listVPCs,updateVPC", "required": false, - "since": "4.15", "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, - "type": "uuid" + "since": "4.21.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": "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": "list by the service offering", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering,listServiceOfferings", + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" + }, + { + "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,createVMFromBackup,importVm", "required": false, - "since": "4.4", "type": "uuid" }, + { + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, { "description": "List by keyword", "length": 255, @@ -158219,104 +159360,115 @@ "type": "string" }, { - "description": "makes the API's response contains only the resource count", + "description": "list vms by template", "length": 255, - "name": "retrieveonlyresourcecount", + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "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": "the availability zone ID", + "description": "the group ID", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "groupid", + "related": "", "required": false, "type": "uuid" }, { - "description": "Whether to return only leased instances", + "description": "the target hypervisor for the template", "length": 255, - "name": "leased", + "name": "hypervisor", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "string" }, { - "description": "list only resources belonging to the domain specified", + "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": "domainid", - "related": "listDomains", + "name": "accumulate", "required": false, - "type": "uuid" + "since": "4.17.0", + "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": "flag to display the resource icon for VMs", "length": 255, - "name": "listall", + "name": "showicon", "required": false, + "since": "4.16.0.0", "type": "boolean" }, { - "description": "list by the backup offering", + "description": "List resources by tags (key/value pairs)", "length": 255, - "name": "backupofferingid", - "related": "", + "name": "tags", "required": false, - "since": "4.17", - "type": "uuid" + "type": "map" }, { - "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": "list by the service offering", "length": 255, - "name": "accumulate", + "name": "serviceofferingid", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.17.0", - "type": "boolean" + "since": "4.4", + "type": "uuid" }, { - "description": "list vms by affinity group", + "description": "list vms by iso", "length": 255, - "name": "affinitygroupid", - "related": "", + "name": "isoid", "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 IDs of the virtual machines, mutually exclusive with id", "length": 255, - "name": "isrecursive", + "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,createVMFromBackup,importVm", "required": false, - "type": "boolean" + "since": "4.4", + "type": "list" }, { - "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": "Flag to indicate if the VMs should be filtered by GPU support. If set to true, only VMs that support GPU will be returned.", + "description": "The ID of the Orchestrator extension for the VM", "length": 255, - "name": "gpuenabled", + "name": "extensionid", + "related": "listExtensions", "required": false, "since": "4.21.0", - "type": "boolean" + "type": "uuid" }, { - "description": "the group ID", + "description": "makes the API's response contains only the resource count", "length": 255, - "name": "groupid", - "related": "", + "name": "retrieveonlyresourcecount", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the instances by userdata", "length": 255, - "name": "tags", + "name": "userdataid", + "related": "", "required": false, - "type": "map" + "since": "4.20.1", + "type": "uuid" }, { "description": "list by network id", @@ -158325,44 +159477,29 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" - }, - { - "description": "list vms by ssh keypair name", - "length": 255, - "name": "keypair", - "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" } ], - "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", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", "response": [ { - "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 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 ID of the domain in which the virtual machine exists", - "name": "domainid", + "description": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", - "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 number of display heads", @@ -158370,347 +159507,560 @@ "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "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", + "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 availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "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": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", - "type": "string" + "description": "the list of nics associated with vm", + "name": "nic", + "response": [ + { + "description": "the ID of the corresponding network", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the corresponding network", + "name": "networkname", + "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": "public IP address associated with this nic via Static nat rule", + "name": "publicip", + "type": "string" + }, + { + "description": "the ID of the nic", + "name": "id", + "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": "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": "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": "the ip address of the nic", + "name": "ipaddress", + "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": "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": "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 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 isolated private VLAN type if available", + "name": "isolatedpvlantype", + "type": "string" + }, + { + "description": "the traffic type of the nic", + "name": "traffictype", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the gateway of IPv6 network", + "name": "ip6gateway", + "type": "string" + } + ], + "type": "set" }, { - "description": "ssh key-pairs", - "name": "keypairs", - "type": "string" + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, - {}, { - "description": "User VM type", - "name": "vmtype", + "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 speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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", + "description": "Guest vm Boot Type", + "name": "boottype", "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": "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", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "the project name of the vm", - "name": "project", - "type": "string" - }, - { - "description": "OS type id of the vm", - "name": "ostypeid", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", + "description": "the memory allocated for the virtual machine", + "name": "memory", "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", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", - "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 project name of the vm", + "name": "project", + "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": "State of the Service from LB rule", + "name": "servicestate", "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 netmask of the nic", - "name": "netmask", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the traffic type of the nic", - "name": "traffictype", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "public IP address associated with this nic via Static nat rule", - "name": "publicip", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "Id of the NSX Logical Switch Port (if NSX based), null otherwise", - "name": "nsxlogicalswitchport", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the project name of the affinity group", + "name": "project", "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": "the ID of the corresponding network", - "name": "networkid", + "description": "the domain ID of the affinity group", + "name": "domainid", "type": "string" }, { - "description": "public IP address id associated with this nic via Static nat rule", - "name": "publicipid", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "isdefault", - "type": "boolean" - }, - { - "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", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "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": "the gateway of IPv6 network", - "name": "ip6gateway", - "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" - }, + } + ], + "type": "set" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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": "ssh key-pairs", + "name": "keypairs", + "type": "string" + }, + { + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" + }, + { + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", + "type": "string" + }, + { + "description": "the list of resource tags associated", + "name": "tags", + "response": [ { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "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 gateway of the nic", - "name": "gateway", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the project name where tag belongs to", + "name": "project", "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" - }, - { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "resource type", + "name": "resourcetype", "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", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "the ID of the nic", - "name": "id", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the account associated with the tag", + "name": "account", "type": "string" } ], "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "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": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", + "type": "string" + }, + { + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", + "type": "string" + }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "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 current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", + "type": "string" + }, + { + "description": "the name of the template for the virtual machine", + "name": "templatename", + "type": "string" + }, + { + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "the read (IO) of disk on the VM", + "name": "diskioread", + "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": "the ID of the domain in which the virtual machine exists", + "name": "domainid", + "type": "string" }, { "description": "the ID of the availability zone for the virtual machine", @@ -158718,56 +160068,172 @@ "type": "string" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "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 vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "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" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", + "description": "User VM type", + "name": "vmtype", + "type": "string" + }, + { + "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": "the pool type of the virtual machine", + "name": "pooltype", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "description": "the project id of the vm", + "name": "projectid", + "type": "string" + }, + { + "description": "Name of AutoScale VM group", + "name": "autoscalevmgroupname", + "type": "string" + }, + { + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" + }, + { + "description": "the account associated with the virtual machine", + "name": "account", + "type": "string" + }, + { + "description": "the group name of the virtual machine", + "name": "group", + "type": "string" + }, + { + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", + "type": "string" + }, + { + "description": "OS name of the vm", + "name": "osdisplayname", + "type": "string" + }, + { + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, + { + "description": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "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": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", + "type": "string" + }, + { + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "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", + "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 security groups associated with the virtual machine", "name": "securitygroup", "response": [ - { - "description": "the ID of the security group", - "name": "id", - "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" - }, { "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 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 protocol of the security group rule", - "name": "protocol", + "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", + "type": "integer" + }, + { + "description": "the CIDR notation for the base IP address of the security group rule", + "name": "cidr", "type": "string" }, { @@ -158775,86 +160241,71 @@ "name": "tags", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "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": "the project name where tag belongs to", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "tag value", - "name": "value", + "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": "resource type", - "name": "resourcetype", + "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 project id the tag belongs to", - "name": "projectid", + "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" }, { - "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": "customer associated with the tag", - "name": "customer", + "description": "tag value", + "name": "value", "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": "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 starting IP of the security group rule", + "name": "startport", "type": "integer" }, { @@ -158863,111 +160314,44 @@ "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": "account owning the security group rule", - "name": "account", + "description": "the protocol of the security group rule", + "name": "protocol", "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 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": "the account associated with the tag", + "description": "account owning the security group rule", "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": "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": "resource type", - "name": "resourcetype", - "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" - } - ], - "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 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 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", "type": "string" }, { @@ -158976,8 +160360,8 @@ "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" }, { @@ -158985,49 +160369,39 @@ "name": "customer", "type": "string" }, - { - "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" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "the project id the tag belongs to", - "name": "projectid", + "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" } ], "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", @@ -159039,14 +160413,14 @@ "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", - "type": "string" + "description": "the code for the ICMP message response", + "name": "icmpcode", + "type": "integer" }, { "description": "the ending IP of the security group rule ", @@ -159054,452 +160428,215 @@ "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 code for the ICMP message response", - "name": "icmpcode", + "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 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 total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "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": "the password (if exists) of the virtual machine", - "name": "password", - "type": "string" - }, - { - "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": "CPU arch of the VM", - "name": "arch", - "type": "string" - }, - { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", - "type": "string" - }, - {}, - { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "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 maximum X resolution", - "name": "maxresolutionx", - "type": "long" - }, - { - "description": "the account associated with the virtual machine", - "name": "account", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "the group name of the virtual machine", - "name": "group", - "type": "string" - }, - { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the host for the virtual machine", - "name": "hostid", - "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" - }, - { - "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", - "type": "string" - }, - { - "description": "Os type ID of the virtual machine", - "name": "guestosid", - "type": "string" - }, - { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" - }, - { - "description": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" - }, - { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", - "type": "string" - }, - { - "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": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" - }, - { - "description": "customer associated with the tag", - "name": "customer", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the project id of the group", + "name": "projectid", "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": "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", + "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 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 id the tag belongs to", + "name": "projectid", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "resource type", - "name": "resourcetype", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "path of the Domain associated with the tag", - "name": "domainpath", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain the security group belongs to", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the group ID of the virtual machine", + "name": "groupid", "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": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "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 id of userdata used for the VM", - "name": "userdataid", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "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 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": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "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": "the date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "the write (IO) of disk on the VM", + "name": "diskiowrite", + "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": "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": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the ID of the service offering of the virtual machine", - "name": "serviceofferingid", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the VM's primary IP address", + "name": "ipaddress", "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" - }, - {} + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", + "type": "string" + } ], "since": "4.19.1" }, @@ -159508,13 +160645,6 @@ "isasync": false, "name": "addStratosphereSsp", "params": [ - { - "description": "stratosphere ssp api password", - "length": 255, - "name": "password", - "required": false, - "type": "string" - }, { "description": "stratosphere ssp api name", "length": 255, @@ -159522,13 +160652,6 @@ "required": true, "type": "string" }, - { - "description": "stratosphere ssp api username", - "length": 255, - "name": "username", - "required": false, - "type": "string" - }, { "description": "the zone ID", "length": 255, @@ -159538,33 +160661,36 @@ "type": "uuid" }, { - "description": "stratosphere ssp server url", + "description": "stratosphere ssp tenant uuid", "length": 255, - "name": "url", - "required": true, + "name": "tenantuuid", + "required": false, "type": "string" }, { - "description": "stratosphere ssp tenant uuid", + "description": "stratosphere ssp api password", "length": 255, - "name": "tenantuuid", + "name": "password", "required": false, "type": "string" - } - ], - "related": "", - "response": [ - {}, + }, { - "description": "server id of the stratosphere ssp server", - "name": "hostid", + "description": "stratosphere ssp api username", + "length": 255, + "name": "username", + "required": false, "type": "string" }, { - "description": "name", - "name": "name", + "description": "stratosphere ssp server url", + "length": 255, + "name": "url", + "required": true, "type": "string" - }, + } + ], + "related": "", + "response": [ { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -159575,6 +160701,8 @@ "name": "zoneid", "type": "string" }, + {}, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -159585,7 +160713,16 @@ "name": "url", "type": "string" }, - {} + { + "description": "server id of the stratosphere ssp server", + "name": "hostid", + "type": "string" + }, + { + "description": "name", + "name": "name", + "type": "string" + } ] }, { @@ -159601,12 +160738,12 @@ "type": "string" }, { - "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", + "description": "the cluster ID for the storage pool", "length": 255, - "name": "storageaccessgroups", + "name": "clusterid", + "related": "addCluster", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { "description": "the tags for the storage pool", @@ -159622,13 +160759,6 @@ "required": false, "type": "boolean" }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "length": 255, - "name": "istagarule", - "required": false, - "type": "boolean" - }, { "description": "the Zone ID for the storage pool", "length": 255, @@ -159638,19 +160768,18 @@ "type": "uuid" }, { - "description": "IOPS CloudStack can provision from this storage pool", + "description": "the storage provider name", "length": 255, - "name": "capacityiops", + "name": "provider", "required": false, - "type": "long" + "type": "string" }, { - "description": "the Pod ID for the storage pool", + "description": "IOPS CloudStack can provision from this storage pool", "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", + "name": "capacityiops", "required": false, - "type": "uuid" + "type": "long" }, { "description": "the details for the storage pool", @@ -159660,126 +160789,135 @@ "type": "map" }, { - "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": "the name for the storage pool", + "description": "bytes CloudStack can provision from this storage pool", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "capacitybytes", + "required": false, + "type": "long" }, { - "description": "hypervisor type of the hosts in zone that will be attached to this storage pool. KVM, VMware supported as of now.", + "description": "the scope of the storage: cluster or zone", "length": 255, - "name": "hypervisor", + "name": "scope", "required": false, "type": "string" }, { - "description": "bytes CloudStack can provision from this storage pool", + "description": "Whether the informed tag is a JS interpretable rule or not.", "length": 255, - "name": "capacitybytes", + "name": "istagarule", "required": false, - "type": "long" + "type": "boolean" }, { - "description": "the storage provider name", + "description": "the name for the storage pool", "length": 255, - "name": "provider", - "required": false, + "name": "name", + "required": true, "type": "string" }, { - "description": "the scope of the storage: cluster or zone", + "description": "the Pod ID for the storage pool", "length": 255, - "name": "scope", + "name": "podid", + "related": "createManagementNetworkIpRange", + "required": false, + "type": "uuid" + }, + { + "description": "comma separated list of storage access groups for connecting to hosts having those specific groups", + "length": 255, + "name": "storageaccessgroups", "required": false, + "since": "4.21.0", "type": "string" } ], "related": "cancelStorageMaintenance,findStoragePoolsForMigration,enableStorageMaintenance", "response": [ { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "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": "the Pod name of the storage pool", - "name": "podname", + "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", "name": "jobid", "type": "string" }, + {}, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", - "type": "string" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the name of the storage pool", - "name": "name", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + {}, + { + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "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": "the storage pool type", @@ -159787,25 +160925,24 @@ "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the tags for the storage pool", + "name": "tags", "type": "string" }, - {}, { - "description": "the IP address of the storage pool", - "name": "ipaddress", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", - "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": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" }, { "description": "the storage pool capabilities", @@ -159813,53 +160950,58 @@ "type": "map" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" + }, + { + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the storage pool path", - "name": "path", + "description": "the Zone ID of the storage pool", + "name": "zoneid", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "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 date and time the storage pool was created", + "name": "created", + "type": "date" }, { - "description": "the storage pool details", - "name": "details", - "type": "map" + "description": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", - "type": "long" + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the name of the storage pool", + "name": "name", + "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 ID of the storage pool", - "name": "id", + "description": "the Pod name of the storage pool", + "name": "podname", "type": "string" }, { @@ -159868,19 +161010,19 @@ "type": "long" }, { - "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", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "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" } ] }, @@ -159889,6 +161031,13 @@ "isasync": false, "name": "findStoragePoolsForMigration", "params": [ + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -159910,193 +161059,191 @@ "related": "createVolume,attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "required": true, "type": "uuid" - }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" } ], "related": "cancelStorageMaintenance,enableStorageMaintenance", "response": [ { - "description": "the Zone name of the storage pool", - "name": "zonename", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the storage pool custom stats", - "name": "storagecustomstats", - "type": "map" + "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 name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "total min IOPS currently in use by volumes", - "name": "allocatediops", + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", "type": "long" }, { - "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": "the pool'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 pool's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "Storage provider for this pool", + "name": "provider", + "type": "string" }, + {}, { - "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 storage pool capabilities", + "name": "storagecapabilities", + "type": "map" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", "type": "long" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "the tags for the storage pool", - "name": "tags", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the name of the storage pool", + "name": "name", "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", "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "the total disk size of the storage pool", + "name": "disksizetotal", "type": "long" }, - {}, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "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 Pod name of the storage pool", - "name": "podname", + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", "type": "string" }, { - "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 UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod name of the storage pool", + "name": "podname", "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 total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - { - "description": "the scope of the storage pool", - "name": "scope", + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "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": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "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", + "type": "string" }, { "description": "the storage pool details", "name": "details", "type": "map" }, + {}, { - "description": "true if this pool is suitable to migrate a volume, false otherwise", - "name": "suitableformigration", - "type": "boolean" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "description": "the Pod ID of the storage pool", + "name": "podid", + "type": "string" + }, + { + "description": "the ID of the cluster for the storage pool", + "name": "clusterid", + "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 state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" } ] }, @@ -160105,13 +161252,6 @@ "isasync": true, "name": "deleteTungstenFabricFirewallRule", "params": [ - { - "description": "the uuid of Tungsten-Fabric firewall rule", - "length": 255, - "name": "firewallruleuuid", - "required": true, - "type": "string" - }, { "description": "the ID of zone", "length": 255, @@ -160119,30 +161259,37 @@ "related": "listZones", "required": true, "type": "uuid" + }, + { + "description": "the uuid of Tungsten-Fabric firewall rule", + "length": 255, + "name": "firewallruleuuid", + "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": "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" + }, {} ] }, @@ -160163,28 +161310,28 @@ "related": "listCiscoNexusVSMs", "response": [ { - "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": "control vlan id of the VSM", - "name": "vsmctrlvlanid", + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", "type": "int" }, { - "description": "device name", - "name": "vsmdevicename", + "description": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "The mode of the VSM (standalone/HA)", - "name": "vsmconfigmode", + "description": "The Device State (Enabled/Disabled) of the VSM", + "name": "vsmdevicestate", "type": "string" }, { - "description": "device state", - "name": "vsmdevicestate", + "description": "The Config State (Primary/Standby) of the VSM", + "name": "vsmconfigstate", "type": "string" }, { @@ -160193,47 +161340,47 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" }, {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", + "description": "device name", + "name": "vsmdevicename", "type": "string" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", + "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", + "name": "vsmdomainid", "type": "string" }, - {}, { - "description": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" }, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", + "description": "device state", + "name": "vsmdevicestate", "type": "string" }, { - "description": "device id of the Cisco N1KV VSM device", - "name": "vsmdeviceid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", - "name": "vsmdomainid", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", "type": "int" - } + }, + {} ] }, { @@ -160241,6 +161388,13 @@ "isasync": true, "name": "createStorageNetworkIpRange", "params": [ + { + "description": "the netmask for storage network", + "length": 255, + "name": "netmask", + "required": true, + "type": "string" + }, { "description": "UUID of pod where the ip range belongs to", "length": 255, @@ -160249,13 +161403,6 @@ "required": true, "type": "uuid" }, - { - "description": "the ending IP address", - "length": 255, - "name": "endip", - "required": false, - "type": "string" - }, { "description": "the gateway for storage network", "length": 255, @@ -160264,65 +161411,54 @@ "type": "string" }, { - "description": "the beginning IP address", + "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", "length": 255, - "name": "startip", - "required": true, - "type": "string" + "name": "vlan", + "required": false, + "type": "integer" }, { - "description": "the netmask for storage network", + "description": "the beginning IP address", "length": 255, - "name": "netmask", + "name": "startip", "required": true, "type": "string" }, { - "description": "Optional. The vlan the ip range sits on, default to Null when it is not specified which means your network is not on any Vlan. This is mainly for Vmware as other hypervisors can directly retrieve bridge from physical network traffic type table", + "description": "the ending IP address", "length": 255, - "name": "vlan", + "name": "endip", "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 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 start ip of the storage network IP range", + "name": "startip", "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 start ip of the storage network IP range", - "name": "startip", + "description": "the uuid of storage network IP range.", + "name": "id", "type": "string" }, - {}, { "description": "the Zone uuid of the storage network IP range", "name": "zoneid", "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 netmask of the storage network IP range", @@ -160330,8 +161466,13 @@ "type": "string" }, { - "description": "the ID or VID of the VLAN.", - "name": "vlan", + "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" }, { @@ -160339,9 +161480,15 @@ "name": "podid", "type": "string" }, + {}, { - "description": "the network uuid of storage network IP range", - "name": "networkid", + "description": "the gateway of the storage network IP range", + "name": "gateway", + "type": "string" + }, + { + "description": "the end ip of the storage network IP range", + "name": "endip", "type": "string" } ], @@ -160353,57 +161500,53 @@ "name": "configureOvsElement", "params": [ { - "description": "the ID of the ovs provider", + "description": "Enabled/Disabled the service provider", "length": 255, - "name": "id", - "related": "configureOvsElement", + "name": "enabled", "required": true, - "type": "uuid" + "type": "boolean" }, { - "description": "Enabled/Disabled the service provider", + "description": "the ID of the ovs provider", "length": 255, - "name": "enabled", + "name": "id", + "related": "configureOvsElement", "required": true, - "type": "boolean" + "type": "uuid" } ], "related": "", "response": [ - {}, - { - "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", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the project id of the ipaddress", - "name": "projectid", - "type": "string" + "description": "Enabled/Disabled the service provider", + "name": "enabled", + "type": "boolean" }, { "description": "the project name of the address", "name": "project", "type": "string" }, + {}, + {}, { - "description": "the domain ID associated with the provider", - "name": "domainid", + "description": "the id of the ovs", + "name": "id", "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 id of the ovs", - "name": "id", + "description": "path of the domain to which the provider belongs", + "name": "domainpath", "type": "string" }, { @@ -160412,20 +161555,24 @@ "type": "string" }, { - "description": "Enabled/Disabled the service provider", - "name": "enabled", - "type": "boolean" + "description": "the domain ID associated with the provider", + "name": "domainid", + "type": "string" + }, + { + "description": "the domain associated with the provider", + "name": "domain", + "type": "string" }, { "description": "the account associated with the provider", "name": "account", "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" } ] }, @@ -160435,19 +161582,25 @@ "name": "listSystemVmsUsageHistory", "params": [ { - "description": "name of the system VMs (a substring match is made against the parameter value returning the data for all matching VMs).", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the IDs of the system VMs, mutually exclusive with id.", + "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "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,importVm", + "name": "startdate", "required": false, - "type": "list" + "type": "date" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" }, { "description": "", @@ -160457,9 +161610,9 @@ "type": "integer" }, { - "description": "start date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", + "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", "length": 255, - "name": "startdate", + "name": "enddate", "required": false, "type": "date" }, @@ -160467,66 +161620,132 @@ "description": "the ID of the system VM.", "length": 255, "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", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", "required": false, "type": "uuid" }, { - "description": "end date to filter stats.Use format \"yyyy-MM-dd hh:mm:ss\")", - "length": 255, - "name": "enddate", - "required": false, - "type": "date" - }, - { - "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": "", + "description": "the IDs of the system VMs, mutually exclusive with id.", "length": 255, - "name": "page", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "list" } ], "related": "", "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", + "type": "string" + }, { "description": "the list of VM stats", "name": "stats", + "response": [ + { + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the amount of downloaded data by the VM in MiB", + "name": "networkread", + "type": "string" + }, + { + "description": "the VM's disk number of read requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskioread", + "type": "long" + }, + { + "description": "the amount (percentage) of the VM's CPU currently used", + "name": "cpuused", + "type": "string" + }, + { + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" + }, + { + "description": "the total disk iops since the last stats retrieval", + "name": "diskiopstotal", + "type": "long" + }, + { + "description": "the amount of uploaded data by the VM in MiB", + "name": "networkwrite", + "type": "string" + }, + { + "description": "the time when the VM stats were collected. The format is 'yyyy-MM-dd hh:mm:ss'", + "name": "timestamp", + "type": "date" + }, + { + "description": "the VM's disk number of write requests (IO) made in the last collection cycle as defined by vm.stats.interval configuration", + "name": "diskiowrite", + "type": "long" + }, + { + "description": "the memory used by the VM in KB", + "name": "memorykbs", + "type": "long" + }, + { + "description": "the target memory in VM (KB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the VM's free memory in KB or -1 if it cannot be gathered", + "name": "memoryintfreekbs", + "type": "long" + }, + { + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" + } + ], "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 name of the virtual machine", "name": "name", "type": "string" }, - { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", - "type": "string" - } + {} ], "since": "4.18.0" }, @@ -160545,27 +161764,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": "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" - }, {} ] }, @@ -160574,6 +161793,13 @@ "isasync": true, "name": "createFirewallRule", "params": [ + { + "description": "the ending port of firewall rule", + "length": 255, + "name": "endport", + "required": false, + "type": "integer" + }, { "description": "the protocol for the firewall rule. Valid values are TCP/UDP/ICMP.", "length": 255, @@ -160582,25 +161808,18 @@ "type": "string" }, { - "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": "type of firewallrule: system/user", - "length": 255, - "name": "type", - "required": false, - "type": "string" - }, - { - "description": "type of the ICMP message being sent", + "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", "length": 255, - "name": "icmptype", + "name": "cidrlist", "required": false, - "type": "integer" + "type": "list" }, { "description": "the IP address id of the port forwarding rule", @@ -160611,25 +161830,25 @@ "type": "uuid" }, { - "description": "the starting port of firewall rule", + "description": "type of firewallrule: system/user", "length": 255, - "name": "startport", + "name": "type", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ending port of firewall rule", + "description": "error code for this icmp message", "length": 255, - "name": "endport", + "name": "icmpcode", "required": false, "type": "integer" }, { - "description": "the CIDR list to forward traffic from. Multiple entries must be separated by a single comma character (,).", + "description": "type of the ICMP message being sent", "length": 255, - "name": "cidrlist", + "name": "icmptype", "required": false, - "type": "list" + "type": "integer" }, { "description": "an optional field, whether to the display the rule to the end user or not", @@ -160643,69 +161862,57 @@ "related": "updateEgressFirewallRule", "response": [ { - "description": "the public ip address id for the firewall rule", - "name": "ipaddressid", - "type": "string" - }, - {}, - { - "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", - "name": "destcidrlist", - "type": "string" + "description": "the starting port of firewall rule's port range", + "name": "startport", + "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 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": "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 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 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": "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 public ip address for the firewall rule", + "name": "ipaddress", + "type": "string" }, { "description": "the list of resource tags associated with the rule", "name": "tags", "response": [ { - "description": "resource type", - "name": "resourcetype", + "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" }, { @@ -160714,13 +161921,13 @@ "type": "string" }, { - "description": "tag key name", - "name": "key", + "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" }, { @@ -160729,41 +161936,42 @@ "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": "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 value", - "name": "value", + "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" } ], "type": "list" }, { - "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 ID of the firewall rule", - "name": "id", + "description": "the cidr list to forward traffic to. Multiple entries are separated by a single comma character (,).", + "name": "destcidrlist", "type": "string" }, { @@ -160772,20 +161980,31 @@ "type": "string" }, { - "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": "error code for this icmp message", - "name": "icmpcode", - "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 state of the rule", + "name": "state", + "type": "string" + }, + { + "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" - } + }, + {} ] }, { @@ -160794,19 +162013,26 @@ "name": "createVolume", "params": [ { - "description": "an optional field, whether to display the volume to the end user or not.", + "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", "length": 255, - "name": "displayvolume", + "name": "diskofferingid", + "related": "", "required": false, - "type": "boolean" + "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": "min iops", "length": 255, - "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", + "name": "miniops", "required": false, - "type": "uuid" + "type": "long" + }, + { + "description": "an optional field, whether to display the volume to the end user or not.", + "length": 255, + "name": "displayvolume", + "required": false, + "type": "boolean" }, { "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.", @@ -160817,11 +162043,11 @@ "type": "uuid" }, { - "description": "max iops", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "maxiops", + "name": "customid", "required": false, - "type": "long" + "type": "string" }, { "description": "the project associated with the volume. Mutually exclusive with account parameter", @@ -160832,24 +162058,24 @@ "type": "uuid" }, { - "description": "Arbitrary volume size", + "description": "the name of the disk volume", "length": 255, - "name": "size", + "name": "name", "required": false, - "type": "long" + "type": "string" }, { - "description": "the account associated with the disk volume. Must be used with the domainId parameter.", + "description": "Arbitrary volume size", "length": 255, - "name": "account", + "name": "size", "required": false, - "type": "string" + "type": "long" }, { - "description": "the ID of the availability zone", + "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": "zoneid", - "related": "listZones", + "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,createVMFromBackup,importVm", "required": false, "type": "uuid" }, @@ -160862,66 +162088,68 @@ "type": "uuid" }, { - "description": "min iops", - "length": 255, - "name": "miniops", - "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", + "description": "the account associated with the disk volume. Must be used with the domainId parameter.", "length": 255, - "name": "customid", + "name": "account", "required": false, "type": "string" }, { - "description": "the ID of the disk offering. Either diskOfferingId or snapshotId must be passed in.", + "description": "the ID of the availability zone", "length": 255, - "name": "diskofferingid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "the name of the disk volume", + "description": "max iops", "length": 255, - "name": "name", + "name": "maxiops", "required": false, - "type": "string" + "type": "long" } ], "related": "attachVolume,createVolume,detachVolume,migrateVolume,resizeVolume,updateVolume,uploadVolume,listVolumes,destroyVolume,recoverVolume", "response": [ { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the chain info of the volume", + "name": "chaininfo", "type": "string" }, { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", + "description": "the status of the volume", + "name": "status", "type": "string" }, - {}, { - "description": "ID of the snapshot from which this volume was created", - "name": "snapshotid", + "description": "shared or local storage", + "name": "storagetype", "type": "string" }, { - "description": "Hypervisor the volume belongs to", - "name": "hypervisor", + "description": "name of the availability zone", + "name": "zonename", "type": "string" }, { - "description": "display name of the virtual machine", - "name": "vmdisplayname", + "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": "cluster name where the volume is allocated", + "name": "clustername", "type": "string" }, { - "description": "the path of the volume", - "name": "path", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "type": "string" }, { @@ -160930,14 +162158,20 @@ "type": "date" }, { - "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": "id of the primary storage hosting the disk volume; returned to admin user only", + "name": "storageid", "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": "provisioning type used to create volumes.", @@ -160945,120 +162179,145 @@ "type": "string" }, { - "description": "the project id of the vpn", - "name": "projectid", + "description": "min iops of the disk volume", + "name": "miniops", + "type": "long" + }, + { + "description": "the bytes actually consumed on disk", + "name": "physicalsize", + "type": "long" + }, + { + "description": "true if storage snapshot is supported for the volume, false otherwise", + "name": "supportsstoragesnapshot", + "type": "boolean" + }, + { + "description": "need quiesce vm or not when taking snapshot", + "name": "quiescevm", + "type": "boolean" + }, + { + "description": "state of the virtual machine", + "name": "vmstate", "type": "string" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "ID of the availability zone", + "name": "zoneid", "type": "string" }, + { + "description": "the date the disk volume was created", + "name": "created", + "type": "date" + }, { "description": "the list of resource tags associated", "name": "tags", "response": [ { - "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 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 ID of the domain associated with the tag", + "name": "domainid", "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": "path of the Domain associated with the tag", - "name": "domainpath", + "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "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": "customer associated with the tag", + "name": "customer", "type": "string" } ], "type": "set" }, { - "description": "size of the disk volume", - "name": "size", - "type": "long" + "description": "ID of the disk volume", + "name": "id", + "type": "string" }, { - "description": "the disk utilization", - "name": "utilization", - "type": "string" + "description": "bytes read rate of the disk volume", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "the ID of the domain associated with the disk volume", - "name": "domainid", + "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": "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 ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "path of the Domain the disk volume belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "bytes write rate of the disk volume", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "the date the disk volume was created", - "name": "created", - "type": "date" + "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": "type of the disk volume (ROOT or DATADISK)", + "name": "type", "type": "string" }, { - "description": "path of the Domain the disk volume belongs to", - "name": "domainpath", + "description": "name of the virtual machine", + "name": "vmname", "type": "string" }, { @@ -161067,229 +162326,184 @@ "type": "long" }, { - "description": "name of the availability zone", - "name": "zonename", - "type": "string" - }, - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "size of the disk volume", + "name": "size", + "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", - "name": "diskofferingname", - "type": "string" - }, { "description": "name of the primary storage hosting the disk volume", "name": "storage", "type": "string" }, { - "description": "the bytes allocated", - "name": "virtualsize", - "type": "long" - }, - { - "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": "ID of the disk volume", - "name": "id", + "description": "the state of the disk volume", + "name": "state", "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": "IO requests read rate of the disk volume per the disk offering", - "name": "diskIopsReadRate", - "type": "long" - }, - { - "description": "cluster name where the volume is allocated", - "name": "clustername", + "description": "the disk utilization", + "name": "utilization", "type": "string" }, { - "description": "state of the virtual machine", - "name": "vmstate", + "description": "ID of the service offering for root disk", + "name": "serviceofferingid", "type": "string" }, { - "description": "type of the disk volume (ROOT or DATADISK)", - "name": "type", + "description": "pod name of the volume", + "name": "podname", "type": "string" }, { - "description": "the format of the disk encryption if applicable", - "name": "encryptformat", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, + {}, { - "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 read (IO) of disk on the vm", - "name": "diskioread", + "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", - "type": "boolean" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "ID of the disk offering", - "name": "diskofferingid", + "description": "cluster id of the volume", + "name": "clusterid", "type": "string" }, { - "description": "name of the disk volume", - "name": "name", + "description": "Hypervisor the volume belongs to", + "name": "hypervisor", "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" - }, - { - "description": "pod name of the volume", - "name": "podname", - "type": "string" + "description": "details for the volume check result, they may vary for different hypervisors", + "name": "volumecheckresult", + "type": "map" }, { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "type of the virtual machine", + "name": "vmtype", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "bytes write rate of the disk volume", - "name": "diskBytesWriteRate", + "description": "the bytes allocated", + "name": "virtualsize", "type": "long" }, { - "description": "the boolean state of whether the volume is destroyed or not", - "name": "destroyed", - "type": "boolean" - }, - { - "description": "true if volume has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "the write (IO) of disk on the vm", + "name": "diskiowrite", + "type": "long" }, { - "description": "cluster id of the volume", - "name": "clusterid", + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the state of the disk volume", - "name": "state", + "description": "pod id of the volume", + "name": "podid", "type": "string" }, { - "description": "true if the volume is extractable, false otherwise", - "name": "isextractable", - "type": "boolean" - }, - { - "description": "the chain info of the volume", - "name": "chaininfo", + "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": "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": "details for the volume check result, they may vary for different hypervisors", - "name": "volumecheckresult", - "type": "map" + "description": "the display text of the service offering for root disk", + "name": "serviceofferingdisplaytext", + "type": "string" }, { - "description": "the status of the volume", - "name": "status", + "description": "the path of the volume", + "name": "path", "type": "string" }, { - "description": "name of the service offering for root disk", - "name": "serviceofferingname", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, { - "description": "true if storage snapshot is supported for the volume, false otherwise", - "name": "supportsstoragesnapshot", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "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": "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 disk offering", + "name": "diskofferingname", "type": "string" }, { - "description": "ID of the service offering for root disk", - "name": "serviceofferingid", + "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": "ID of the disk offering", + "name": "diskofferingid", + "type": "string" }, { - "description": "name of the virtual machine", - "name": "vmname", + "description": "name of the disk volume", + "name": "name", "type": "string" }, { - "description": "the display text of the service offering for root disk", - "name": "serviceofferingdisplaytext", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, - {}, { - "description": "max iops of the disk volume", - "name": "maxiops", - "type": "long" + "description": "the account associated with the disk volume", + "name": "account", + "type": "string" }, { - "description": "need quiesce vm or not when taking snapshot", - "name": "quiescevm", + "description": "true if volume has delete protection.", + "name": "deleteprotection", "type": "boolean" }, { @@ -161298,24 +162512,29 @@ "type": "long" }, { - "description": "ID of the availability zone", - "name": "zoneid", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, { - "description": "type of the virtual machine", - "name": "vmtype", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, { - "description": "bytes read rate of the disk volume", - "name": "diskBytesReadRate", + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", "type": "long" }, { - "description": "min iops of the disk volume", - "name": "miniops", - "type": "long" + "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", + "type": "string" } ] }, @@ -161325,11 +162544,19 @@ "name": "listVMSnapshot", "params": [ { - "description": "lists snapshot by snapshot name or display name", + "description": "list resources by account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, + "type": "string" + }, + { + "description": "The ID of the VM snapshot", "length": 255, - "name": "name", + "name": "vmsnapshotid", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "string" + "type": "uuid" }, { "description": "list only resources belonging to the domain specified", @@ -161340,93 +162567,85 @@ "type": "uuid" }, { - "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 resources by account. Must be used with the domainId parameter.", + "description": "lists snapshot by snapshot name or display name", "length": 255, - "name": "account", + "name": "name", "required": false, "type": "string" }, { - "description": "", + "description": "state of the virtual machine snapshot", "length": 255, - "name": "page", + "name": "state", "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": "List resources by tags (key/value pairs)", "length": 255, - "name": "listall", + "name": "tags", "required": false, - "type": "boolean" + "type": "map" }, { - "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", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, - { - "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", + "description": "", "length": 255, - "name": "vmsnapshotids", - "related": "listVMSnapshot,createVMSnapshot", + "name": "pagesize", "required": false, - "since": "4.9", - "type": "list" + "type": "integer" }, { - "description": "state of the virtual machine snapshot", + "description": "the ID of the vm", "length": 255, - "name": "state", + "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,createVMFromBackup,importVm", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the ID of the vm", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "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", + "name": "projectid", + "related": "", "required": false, "type": "uuid" }, { - "description": "The ID of the VM snapshot", + "description": "", "length": 255, - "name": "vmsnapshotid", - "related": "listVMSnapshot,createVMSnapshot", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "List resources by tags (key/value pairs)", + "description": "the IDs of the vm snapshots, mutually exclusive with vmsnapshotid", "length": 255, - "name": "tags", + "name": "vmsnapshotids", + "related": "listVMSnapshot,createVMSnapshot", "required": false, - "type": "map" + "since": "4.9", + "type": "list" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" } ], "related": "createVMSnapshot", @@ -161438,78 +162657,22 @@ }, {}, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" - }, - { - "description": "the domain associated with the disk volume", - "name": "domain", + "description": "the parent ID of the vm snapshot", + "name": "parent", "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" - }, - { - "description": "the vm name of the vm snapshot", - "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": "customer associated with the tag", - "name": "customer", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -161518,8 +162681,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" }, { @@ -161528,23 +162691,23 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "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": "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": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -161553,41 +162716,41 @@ "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": "resource type", + "name": "resourcetype", "type": "string" } ], "type": "set" }, { - "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", + "type": "string" }, { - "description": "the parent displayName of the vm snapshot", - "name": "parentName", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", "type": "string" }, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "the project name of the vpn", - "name": "project", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { @@ -161595,21 +162758,77 @@ "name": "account", "type": "string" }, + { + "description": "the state of the vm snapshot", + "name": "state", + "type": "state" + }, + { + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", + "type": "string" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", + "type": "string" + }, + { + "description": "the Zone name of the vm snapshot", + "name": "zonename", + "type": "string" + }, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the display name of the vm snapshot", + "name": "displayname", + "type": "string" + }, + { + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "the project name of the vpn", + "name": "project", "type": "string" }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "description": "the name of the vm snapshot", "name": "name", "type": "string" }, + {}, + { + "description": "the parent displayName of the vm snapshot", + "name": "parentName", + "type": "string" + }, + { + "description": "indicates if this is current snapshot", + "name": "current", + "type": "boolean" + }, + { + "description": "the project id of the vpn", + "name": "projectid", + "type": "string" + }, { "description": "the ID of the domain associated with the disk volume", "name": "domainid", @@ -161624,10 +162843,10 @@ "name": "moveNetworkAclItem", "params": [ { - "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" }, { @@ -161638,59 +162857,50 @@ "type": "string" }, { - "description": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "aclconsistencyhash", + "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": "The ID of the network ACL rule that is being moved to a new position.", "length": 255, - "name": "customid", - "required": false, - "since": "4.4", + "name": "id", + "required": true, "type": "string" }, { - "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": "Md5 hash used to check the consistency of the ACL rule list before applying the ACL rule move. This check is useful to manage concurrency problems that may happen when multiple users are editing the same ACL rule listing. The parameter is not required. Therefore, if the user does not send it, they assume the risk of moving ACL rules without checking the consistency of the access control list before executing the move. We use MD5 hash function on a String that is composed of all UUIDs of the ACL rules in concatenated in their respective order (order defined via 'number' field).", "length": 255, - "name": "previousaclruleid", + "name": "aclconsistencyhash", "required": false, "type": "string" } ], "related": "", "response": [ - {}, - { - "description": "the starting port of ACL's port range", - "name": "startport", - "type": "string" - }, { - "description": "the traffic type for the ACL", - "name": "traffictype", + "description": "the name of the ACL this item belongs to", + "name": "aclname", "type": "string" }, + {}, + {}, { - "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", - "name": "cidrlist", + "description": "an explanation on why this ACL rule is being applied", + "name": "reason", "type": "string" }, { - "description": "type of the icmp message being sent", - "name": "icmptype", - "type": "integer" - }, - { - "description": "Action of ACL Item. Allow/Deny", - "name": "action", + "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": "the traffic type for the ACL", + "name": "traffictype", "type": "string" }, { @@ -161698,18 +162908,18 @@ "name": "tags", "response": [ { - "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 domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -161718,8 +162928,13 @@ "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", "type": "string" }, { @@ -161728,8 +162943,8 @@ "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { @@ -161737,38 +162952,47 @@ "name": "value", "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", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "list" }, { - "description": "the ID of the ACL Item", - "name": "id", + "description": "type of the icmp message being sent", + "name": "icmptype", + "type": "integer" + }, + { + "description": "the ending port of ACL's port range", + "name": "endport", "type": "string" }, { - "description": "the ID of the ACL this item belongs to", - "name": "aclid", + "description": "the state of the rule", + "name": "state", "type": "string" }, - {}, { - "description": "an explanation on why this ACL rule is being applied", - "name": "reason", + "description": "the cidr list to forward traffic from. Multiple entries are separated by a single comma character (,).", + "name": "cidrlist", + "type": "string" + }, + { + "description": "Number of the ACL Item", + "name": "number", + "type": "integer" + }, + { + "description": "Action of ACL Item. Allow/Deny", + "name": "action", "type": "string" }, { @@ -161777,8 +163001,8 @@ "type": "string" }, { - "description": "the name of the ACL this item belongs to", - "name": "aclname", + "description": "the ID of the ACL this item belongs to", + "name": "aclid", "type": "string" }, { @@ -161787,28 +163011,23 @@ "type": "boolean" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, - { - "description": "the ending port of ACL's port range", - "name": "endport", + "description": "the ID of the ACL Item", + "name": "id", "type": "string" }, { - "description": "the state of the rule", - "name": "state", - "type": "string" + "description": "error code for this icmp message", + "name": "icmpcode", + "type": "integer" }, { - "description": "Number of the ACL Item", - "name": "number", - "type": "integer" + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, { - "description": "error code for this icmp message", - "name": "icmpcode", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", "type": "integer" } ] @@ -161818,14 +163037,6 @@ "isasync": true, "name": "disassociateIpAddress", "params": [ - { - "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", - "length": 255, - "name": "id", - "related": "associateIpAddress,listPublicIpAddresses", - "required": false, - "type": "uuid" - }, { "description": "IP Address to be disassociated. Mutually exclusive with the id parameter", "length": 255, @@ -161833,6 +163044,14 @@ "required": false, "since": "4.19.0", "type": "string" + }, + { + "description": "the ID of the public IP address to disassociate. Mutually exclusive with the ipaddress parameter", + "length": 255, + "name": "id", + "related": "associateIpAddress,listPublicIpAddresses", + "required": false, + "type": "uuid" } ], "response": [ @@ -161843,9 +163062,9 @@ "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" }, {}, { @@ -161854,9 +163073,9 @@ "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" } ] }, @@ -161866,62 +163085,72 @@ "name": "listBaremetalDhcp", "params": [ { - "description": "", + "description": "Type of DHCP device", "length": 255, - "name": "pagesize", + "name": "dhcpservertype", "required": false, - "type": "integer" + "type": "string" }, { - "description": "", + "description": "the Physical Network ID", "length": 255, - "name": "page", - "required": false, - "type": "integer" + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" }, { - "description": "DHCP server device ID", + "description": "List by keyword", "length": 255, - "name": "id", + "name": "keyword", "required": false, - "type": "long" + "type": "string" }, { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "pagesize", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the Physical Network ID", + "description": "DHCP server device ID", "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" + "name": "id", + "required": false, + "type": "long" }, { - "description": "Type of DHCP device", + "description": "", "length": 255, - "name": "dhcpservertype", + "name": "page", "required": false, - "type": "string" + "type": "integer" } ], "related": "", "response": [ + { + "description": "name of the provider", + "name": "dhcpservertype", + "type": "string" + }, + { + "description": "url", + "name": "url", + "type": "string" + }, { "description": "device id of ", "name": "id", "type": "string" }, + {}, { "description": "name of the provider", - "name": "dhcpservertype", + "name": "provider", "type": "string" }, - {}, { "description": "the physical network to which this external dhcp device belongs to", "name": "physicalnetworkid", @@ -161933,20 +163162,10 @@ "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": "url", - "name": "url", - "type": "string" } ] }, @@ -161967,115 +163186,125 @@ "related": "cancelStorageMaintenance", "response": [ { - "description": "the storage pool details", - "name": "details", + "description": "the storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "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", - "type": "map" + "description": "the hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" + "description": "the name of the cluster for the storage pool", + "name": "clustername", + "type": "string" }, { - "description": "total IOPS currently in use", - "name": "usediops", + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" + }, + { + "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 total disk size of the storage pool", + "name": "disksizetotal", + "type": "long" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "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 tags for the storage pool", - "name": "tags", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the ID of the storage pool", - "name": "id", + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, + {}, { - "description": "the Pod ID of the storage pool", - "name": "podid", - "type": "string" + "description": "whether this pool is managed or not", + "name": "managed", + "type": "boolean" }, + {}, { - "description": "the storage pool path", - "name": "path", + "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 access groups for the storage pool", - "name": "storageaccessgroups", + "description": "the scope of the storage pool", + "name": "scope", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the ID of the storage pool", + "name": "id", "type": "string" }, { - "description": "the ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Zone name of the storage pool", + "name": "zonename", "type": "string" }, { - "description": "the host's currently used disk size", - "name": "disksizeused", + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, { - "description": "the storage pool capabilities", - "name": "storagecapabilities", - "type": "map" + "description": "the tags for the storage pool", + "name": "tags", + "type": "string" }, { - "description": "the IP address of the storage pool", - "name": "ipaddress", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "description": "the storage pool type", - "name": "type", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { @@ -162084,29 +163313,34 @@ "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", + "type": "string" }, { - "description": "the name of the cluster for the storage pool", - "name": "clustername", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "total IOPS currently in use", + "name": "usediops", + "type": "long" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + { + "description": "the date and time the storage pool was created", + "name": "created", + "type": "date" }, { "description": "Whether the informed tag is a JS interpretable rule or not.", @@ -162114,33 +163348,23 @@ "type": "boolean" }, { - "description": "the scope of the storage pool", - "name": "scope", - "type": "string" - }, - { - "description": "the nfs mount options for the storage pool", - "name": "nfsmountopts", - "type": "string" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { - "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 Zone name of the storage pool", - "name": "zonename", + "description": "the nfs mount options for the storage pool", + "name": "nfsmountopts", "type": "string" }, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" - }, - { - "description": "whether this pool is managed or not", - "name": "managed", + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", "type": "boolean" } ] @@ -162161,27 +163385,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" - }, - {} + "description": "any text associated with the success or failure", + "name": "displaytext", + "type": "string" + } ], "since": "4.19.0" }, @@ -162200,15 +163424,15 @@ ], "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": "length of the parameter", + "name": "length", + "type": "int" + }, { "description": "comma separated related apis to get the parameter", "name": "related", @@ -162219,59 +163443,59 @@ "name": "since", "type": "string" }, - { - "description": "true if this parameter is required for the api request", - "name": "required", - "type": "boolean" - }, { "description": "description of the api parameter", "name": "description", "type": "string" }, - {}, { "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" + }, + { + "description": "true if this parameter is required for the api request", + "name": "required", + "type": "boolean" } ], "type": "set" }, - { - "description": "the name of the api command", - "name": "name", - "type": "string" - }, { "description": "comma separated related apis", "name": "related", "type": "string" }, - {}, { - "description": "description of the api", - "name": "description", + "description": "response field type", + "name": "type", "type": "string" }, { - "description": "response field type", - "name": "type", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "the name of the api command", + "name": "name", "type": "string" }, + {}, { - "description": "version of CloudStack the api was introduced in", - "name": "since", + "description": "true if api is asynchronous", + "name": "isasync", + "type": "boolean" + }, + { + "description": "description of the api", + "name": "description", "type": "string" }, { @@ -162289,13 +163513,13 @@ "type": "set" }, { - "description": "description of the api response field", - "name": "description", + "description": "the name of the api response field", + "name": "name", "type": "string" }, { - "description": "the name of the api response field", - "name": "name", + "description": "description of the api response field", + "name": "description", "type": "string" } ], @@ -162303,14 +163527,14 @@ }, {}, { - "description": "true if api is asynchronous", - "name": "isasync", - "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": "version of CloudStack the api was introduced in", + "name": "since", + "type": "string" } ], "since": "4.1.0" @@ -162335,12 +163559,12 @@ "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", @@ -162348,9 +163572,9 @@ }, {}, { - "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" } ] }, @@ -162360,38 +163584,38 @@ "name": "createVMSnapshot", "params": [ { - "description": "The ID of the vm", + "description": "snapshot memory if true", "length": 255, - "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" + "name": "snapshotmemory", + "required": false, + "type": "boolean" }, { - "description": "quiesce vm if true", + "description": "The display name of the snapshot", "length": 255, - "name": "quiescevm", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "snapshot memory if true", + "description": "quiesce vm if true", "length": 255, - "name": "snapshotmemory", + "name": "quiescevm", "required": false, "type": "boolean" }, { - "description": "The description of the snapshot", + "description": "The ID of the vm", "length": 255, - "name": "description", - "required": false, - "type": "string" + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" }, { - "description": "The display name of the snapshot", + "description": "The description of the snapshot", "length": 255, - "name": "name", + "name": "description", "required": false, "type": "string" } @@ -162399,29 +163623,30 @@ "related": "", "response": [ { - "description": "the vm ID of the vm snapshot", - "name": "virtualmachineid", + "description": "the domain associated with the disk volume", + "name": "domain", "type": "string" }, + {}, { - "description": "the create date of the vm snapshot", - "name": "created", - "type": "date" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the display name of the vm snapshot", + "name": "displayname", "type": "string" }, { - "description": "the Zone name of the vm snapshot", - "name": "zonename", - "type": "string" + "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", + "type": "string" + }, { "description": "the project name where tag belongs to", "name": "project", @@ -162438,8 +163663,8 @@ "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { @@ -162448,8 +163673,8 @@ "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -162463,62 +163688,52 @@ "type": "string" }, { - "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": "customer associated with the tag", - "name": "customer", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" } ], "type": "set" }, { - "description": "the parent ID of the vm snapshot", - "name": "parent", + "description": "the type of hypervisor on which snapshot is stored", + "name": "hypervisor", "type": "string" }, { - "description": "indicates if this is current snapshot", - "name": "current", - "type": "boolean" + "description": "the project name of the vpn", + "name": "project", + "type": "string" }, { - "description": "the account associated with the disk volume", - "name": "account", + "description": "the vm ID of the vm snapshot", + "name": "virtualmachineid", "type": "string" }, - {}, { "description": "the parent displayName of the vm snapshot", "name": "parentName", "type": "string" }, + {}, { - "description": "the ID of the vm snapshot", - "name": "id", + "description": "the ID of the domain associated with the disk volume", + "name": "domainid", "type": "string" }, { - "description": "the description of the vm snapshot", - "name": "description", + "description": "the Zone ID of the vm snapshot", + "name": "zoneid", "type": "string" }, { - "description": "the state of the vm snapshot", - "name": "state", - "type": "state" - }, - { - "description": "the project id of the vpn", - "name": "projectid", + "description": "the account associated with the disk volume", + "name": "account", "type": "string" }, { @@ -162527,60 +163742,69 @@ "type": "string" }, { - "description": "the type of hypervisor on which snapshot is stored", - "name": "hypervisor", + "description": "the project id of the vpn", + "name": "projectid", "type": "string" }, + { + "description": "indicates if this is current snapshot", + "name": "current", + "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 associated with the disk volume", - "name": "domainid", + "description": "the parent ID of the vm snapshot", + "name": "parent", "type": "string" }, { - "description": "the Zone ID of the vm snapshot", - "name": "zoneid", + "description": "the ID of the vm snapshot", + "name": "id", "type": "string" }, { - "description": "the display name of the vm snapshot", - "name": "displayname", + "description": "the vm name of the vm snapshot", + "name": "virtualmachinename", "type": "string" }, { - "description": "path of the domain to which the disk volume belongs", - "name": "domainpath", + "description": "the name of the vm snapshot", + "name": "name", "type": "string" }, { - "description": "the vm name of the vm snapshot", - "name": "virtualmachinename", + "description": "the Zone name of the vm snapshot", + "name": "zonename", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the description of the vm snapshot", + "name": "description", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "path of the domain to which the disk volume belongs", + "name": "domainpath", + "type": "string" }, - {}, { - "description": "the name of the vm snapshot", - "name": "name", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the domain associated with the disk volume", - "name": "domain", - "type": "string" + "description": "the create date of the vm snapshot", + "name": "created", + "type": "date" + }, + { + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ], "since": "4.2.0" @@ -162601,8 +163825,14 @@ ], "response": [ { - "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" }, { @@ -162611,16 +163841,10 @@ "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", + "description": "any text associated with the success or failure", + "name": "displaytext", "type": "string" }, - {}, {} ], "since": "4.2.0" @@ -162631,12 +163855,11 @@ "name": "listTungstenFabricTagType", "params": [ { - "description": "the ID of zone", + "description": "", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "pagesize", "required": false, - "type": "uuid" + "type": "integer" }, { "description": "List by keyword", @@ -162645,13 +163868,6 @@ "required": false, "type": "string" }, - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "the uuid of Tungsten-Fabric tag type", "length": 255, @@ -162665,10 +163881,25 @@ "name": "page", "required": false, "type": "integer" + }, + { + "description": "the ID of zone", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": false, + "type": "uuid" } ], "related": "", "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", @@ -162684,22 +163915,15 @@ "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" + "description": "Tungsten-Fabric provider zone id", + "name": "zoneid", + "type": "long" } ] }, @@ -162735,48 +163959,44 @@ "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 name of the extracted object", + "name": "name", "type": "string" }, { - "description": "the name of the extracted object", - "name": "name", + "description": "the mode of extraction - upload or download", + "name": "extractMode", "type": "string" }, { - "description": "the status of the extraction", - "name": "status", + "description": "the account id to which the extracted object belongs", + "name": "accountid", "type": "string" }, + {}, { "description": "type of the storage", "name": "storagetype", "type": "string" }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, { "description": "the id of extracted object", "name": "id", "type": "string" }, - { - "description": "zone ID the object was extracted from", - "name": "zoneid", - "type": "string" - }, { "description": "the state of the extracted object", "name": "state", "type": "string" }, { - "description": "the mode of extraction - upload or download", - "name": "extractMode", - "type": "string" - }, - { - "description": "the upload id of extracted object", - "name": "extractId", + "description": "", + "name": "resultstring", "type": "string" }, { @@ -162784,33 +164004,37 @@ "name": "uploadpercentage", "type": "integer" }, - {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone name the object was extracted from", + "name": "zonename", "type": "string" }, { - "description": "the account id to which the extracted object belongs", - "name": "accountid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "zone ID the object was extracted from", + "name": "zoneid", "type": "string" }, { - "description": "zone name the object was extracted from", - "name": "zonename", + "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": "the status of the extraction", + "name": "status", "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" + }, + {} ], "since": "4.20.0" }, @@ -162820,62 +164044,55 @@ "name": "listSSHKeyPairs", "params": [ { - "description": "List by keyword", - "length": 255, - "name": "keyword", - "required": false, - "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": "", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "pagesize", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "A key pair name to look for", + "description": "list resources by account. Must be used with the domainId parameter.", "length": 255, - "name": "name", + "name": "account", "required": false, "type": "string" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "", "length": 255, - "name": "projectid", - "related": "", + "name": "page", "required": false, - "type": "uuid" + "type": "integer" }, { - "description": "the ID of the ssh keypair", + "description": "A public key fingerprint to look for", "length": 255, - "name": "id", - "related": "listSSHKeyPairs", + "name": "fingerprint", "required": false, - "type": "uuid" + "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": "A public key fingerprint to look for", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "fingerprint", + "name": "projectid", + "related": "", "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.", @@ -162885,17 +164102,24 @@ "type": "boolean" }, { - "description": "list only resources belonging to the domain specified", + "description": "the ID of the ssh keypair", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "id", + "related": "listSSHKeyPairs", "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": "A key pair name to look for", + "length": 255, + "name": "name", "required": false, "type": "string" } @@ -162903,19 +164127,29 @@ "related": "", "response": [ { - "description": "Name of the keypair", - "name": "name", + "description": "ID of the ssh keypair", + "name": "id", "type": "string" }, { - "description": "the project name of the keypair owner", - "name": "project", + "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": "Name of the keypair", + "name": "name", "type": "string" }, {}, { - "description": "the domain id of the keypair owner", - "name": "domainid", + "description": "Fingerprint of the public key", + "name": "fingerprint", "type": "string" }, { @@ -162924,9 +164158,9 @@ "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 keypair owner", + "name": "domain", + "type": "string" }, { "description": "the project id of the keypair owner", @@ -162934,31 +164168,21 @@ "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the project name of the keypair owner", + "name": "project", "type": "string" }, { - "description": "Fingerprint of the public key", - "name": "fingerprint", + "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": "ID of the ssh keypair", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, - { - "description": "the domain name of the keypair owner", - "name": "domain", - "type": "string" - } + {} ] }, { @@ -162978,85 +164202,107 @@ "related": "", "response": [ { - "description": "the ID of the storage pool", - "name": "id", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "the storage access groups for the storage pool", + "name": "storageaccessgroups", "type": "string" }, { - "description": "whether this pool is managed or not", - "name": "managed", - "type": "boolean" + "description": "total min IOPS currently in use by volumes", + "name": "allocatediops", + "type": "long" }, { - "description": "the Pod ID of the storage pool", - "name": "podid", + "description": "the name of the cluster for the storage pool", + "name": "clustername", "type": "string" }, { - "description": "the Zone ID of the storage pool", - "name": "zoneid", + "description": "IOPS CloudStack can provision from this storage pool", + "name": "capacityiops", + "type": "long" + }, + { + "description": "the pool's currently used disk size", + "name": "disksizeused", + "type": "long" + }, + {}, + { + "description": "Storage provider for this pool", + "name": "provider", "type": "string" }, { - "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": "the ID of the storage pool", + "name": "id", + "type": "string" }, { - "description": "the hypervisor type of the storage pool", - "name": "hypervisor", + "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": "the storage pool details", - "name": "details", + "description": "the Pod name of the storage pool", + "name": "podname", + "type": "string" + }, + { + "description": "the storage pool capabilities", + "name": "storagecapabilities", "type": "map" }, { - "description": "the storage pool type", - "name": "type", + "description": "the IP address of the storage pool", + "name": "ipaddress", "type": "string" }, { - "description": "the overprovisionfactor for the storage pool", - "name": "overprovisionfactor", + "description": "the storage pool type", + "name": "type", "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "whether this pool is managed or not", + "name": "managed", "type": "boolean" }, { - "description": "the storage pool path", - "name": "path", - "type": "string" + "description": "true if this pool is suitable to migrate a volume, false otherwise", + "name": "suitableformigration", + "type": "boolean" }, + {}, { - "description": "the state of the storage pool", - "name": "state", - "type": "storagepoolstatus" + "description": "bytes CloudStack can provision from this storage pool", + "name": "capacitybytes", + "type": "long" }, { - "description": "the scope of the storage pool", - "name": "scope", - "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 Pod name of the storage pool", - "name": "podname", - "type": "string" - }, { "description": "the Zone name of the storage pool", "name": "zonename", @@ -163068,15 +164314,9 @@ "type": "string" }, { - "description": "the total disk size of the storage pool", - "name": "disksizetotal", - "type": "long" - }, - {}, - { - "description": "the date and time the storage pool was created", - "name": "created", - "type": "date" + "description": "the storage pool details", + "name": "details", + "type": "map" }, { "description": "the UUID of the latest async job acting on this object", @@ -163084,75 +164324,64 @@ "type": "string" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", - "type": "long" - }, - { - "description": "Whether the informed tag is a JS interpretable rule or not.", - "name": "istagarule", - "type": "boolean" + "description": "the overprovisionfactor for the storage pool", + "name": "overprovisionfactor", + "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", + "type": "integer" }, { - "description": "total IOPS currently in use", - "name": "usediops", - "type": "long" + "description": "the state of the storage pool", + "name": "state", + "type": "storagepoolstatus" }, { - "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 IP address of the storage pool", - "name": "ipaddress", + "description": "the storage pool path", + "name": "path", "type": "string" }, { - "description": "IOPS CloudStack can provision from this storage pool", - "name": "capacityiops", + "description": "the pool's currently allocated disk size", + "name": "disksizeallocated", "type": "long" }, - {}, { - "description": "the storage access groups for the storage pool", - "name": "storageaccessgroups", - "type": "string" + "description": "the storage pool custom stats", + "name": "storagecustomstats", + "type": "map" }, { - "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 ID of the cluster for the storage pool", - "name": "clusterid", + "description": "the Pod ID of the storage pool", + "name": "podid", "type": "string" }, { - "description": "Storage provider for this pool", - "name": "provider", + "description": "the scope of the storage pool", + "name": "scope", "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 hypervisor type of the storage pool", + "name": "hypervisor", + "type": "string" }, { - "description": "the name of the storage pool", - "name": "name", - "type": "string" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" } ] }, @@ -163162,12 +164391,12 @@ "name": "updateSnapshotPolicy", "params": [ { - "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" }, { "description": "the ID of the snapshot policy", @@ -163178,58 +164407,68 @@ "type": "uuid" }, { - "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" } ], "related": "", "response": [ + { + "description": "the name of the disk volume", + "name": "volumename", + "type": "string" + }, + { + "description": "the interval type of the snapshot policy", + "name": "intervaltype", + "type": "short" + }, + { + "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 ID of the snapshot policy", + "name": "id", + "type": "string" + }, + { + "description": "the ID of the disk volume", + "name": "volumeid", + "type": "string" + }, { "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": "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", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { @@ -163238,8 +164477,8 @@ "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { @@ -163258,33 +164497,39 @@ "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", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", "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": "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": "is this policy 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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, + {}, { "description": "The list of pools in which snapshot backup is scheduled", "name": "storage", @@ -163292,25 +164537,14 @@ }, {}, { - "description": "the time zone of the snapshot policy", - "name": "timezone", - "type": "string" - }, - { - "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": "time the snapshot is scheduled to be taken.", - "name": "schedule", + "description": "the time zone of the snapshot policy", + "name": "timezone", "type": "string" - }, - { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" } ] }, @@ -163320,11 +164554,19 @@ "name": "quotaSummary", "params": [ { - "description": "", + "description": "Optional, to list all accounts irrespective of the quota activity", "length": 255, - "name": "pagesize", + "name": "listall", "required": false, - "type": "integer" + "type": "boolean" + }, + { + "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" }, { "description": "", @@ -163334,103 +164576,95 @@ "type": "integer" }, { - "description": "Optional, Account Id for which statement needs to be generated", + "description": "List by keyword", "length": 255, - "name": "account", + "name": "keyword", "required": false, "type": "string" }, { - "description": "Optional, If domain Id is given and the caller is domain admin then the statement is generated for domain.", + "description": "", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "pagesize", "required": false, - "type": "uuid" + "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", - "length": 255, - "name": "listall", - "required": false, - "type": "boolean" } ], "related": "", "response": [ { - "description": "domain name", - "name": "domain", - "type": "string" - }, - { - "description": "currency", - "name": "currency", + "description": "account name", + "name": "account", "type": "string" }, - { - "description": "account balance", - "name": "balance", - "type": "bigdecimal" - }, { "description": "account state", "name": "state", "type": "state" }, + {}, { - "description": "account name", - "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": "end date", + "name": "enddate", + "type": "date" + }, + { + "description": "currency", + "name": "currency", "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "account id", + "name": "accountid", + "type": "string" }, - {}, { "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", + "description": "quota usage of this period", + "name": "quota", + "type": "bigdecimal" + }, + { + "description": "domain name", + "name": "domain", "type": "string" }, { - "description": "quota usage of this period", - "name": "quota", + "description": "account balance", + "name": "balance", "type": "bigdecimal" }, { "description": "start date", "name": "startdate", "type": "date" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ], "since": "4.7.0" @@ -163452,96 +164686,96 @@ "related": "", "response": [ { - "description": " the created date of the job", - "name": "created", - "type": "date" + "description": "the account that executed the async command", + "name": "account", + "type": "string" }, { - "description": "the domain id that executed the async command", - "name": "domainid", + "description": "the msid of the management server on which the job is running", + "name": "managementserverid", "type": "string" }, + { + "description": " the completed date of the job", + "name": "completed", + "type": "date" + }, { "description": "the unique ID of the instance/entity object related to the job", "name": "jobinstanceid", "type": "string" }, { - "description": "the msid of the management server on which the job is running", - "name": "managementserverid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the result type", - "name": "jobresulttype", + "description": "the account id that executed the async command", + "name": "accountid", "type": "string" }, { - "description": "the user that executed the async command", - "name": "userid", + "description": "the domain that executed the async command", + "name": "domainpath", "type": "string" }, { - "description": "the progress information of the PENDING job", - "name": "jobprocstatus", - "type": "integer" + "description": "the domain id that executed the async command", + "name": "domainid", + "type": "string" }, { - "description": "the result code for the job", - "name": "jobresultcode", - "type": "integer" + "description": " the created date of the job", + "name": "created", + "type": "date" }, { - "description": "the instance/entity object related to the job", - "name": "jobinstancetype", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the management server name of the host", - "name": "managementservername", - "type": "string" + "description": "the progress information of the PENDING job", + "name": "jobprocstatus", + "type": "integer" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the result type", + "name": "jobresulttype", "type": "string" }, { - "description": "the account id that executed the async command", - "name": "accountid", + "description": "the management server name of the host", + "name": "managementservername", "type": "string" }, + {}, { - "description": " the completed date of the job", - "name": "completed", - "type": "date" - }, - { - "description": "the domain that executed the async command", - "name": "domainpath", + "description": "the instance/entity object related to the job", + "name": "jobinstancetype", "type": "string" }, { - "description": "the account that executed the async command", - "name": "account", + "description": "the async command executed", + "name": "cmd", "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", + "type": "string" }, - {}, { - "description": "the async command executed", - "name": "cmd", - "type": "string" + "description": "the result code for the job", + "name": "jobresultcode", + "type": "integer" } ] }, @@ -163558,16 +164792,16 @@ "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "password", + "name": "username", "required": true, "type": "string" }, { - "description": "Credentials to reach netscaler controlcenter device", + "description": "Credentials to reach netscaler controlcenter device", "length": 255, - "name": "username", + "name": "password", "required": true, "type": "string" }, @@ -163581,41 +164815,41 @@ ], "related": "addNetscalerLoadBalancer", "response": [ - {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", + "description": "private IP of the NetScaler representing GSLB site", + "name": "gslbproviderprivateip", "type": "string" }, + {}, { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "device capacity", - "name": "lbdevicecapacity", - "type": "long" + "description": "device state", + "name": "lbdevicestate", + "type": "string" }, {}, { - "description": "true if NetScaler device is provisioned exclusively to be a GSLB service provider", - "name": "isexclusivegslbprovider", - "type": "boolean" + "description": "device id of the netscaler load balancer", + "name": "lbdeviceid", + "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the public interface of the load balancer", + "name": "publicinterface", + "type": "string" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", - "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": "device name", - "name": "lbdevicename", + "description": "the management IP address of the external load balancer", + "name": "ipaddress", "type": "string" }, { @@ -163624,18 +164858,18 @@ "type": "boolean" }, { - "description": "name of the provider", - "name": "provider", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { - "description": "device id of the netscaler load balancer", - "name": "lbdeviceid", + "description": "the private interface of the load balancer", + "name": "privateinterface", "type": "string" }, { - "description": "the management IP address of the external load balancer", - "name": "ipaddress", + "description": "name of the provider", + "name": "provider", "type": "string" }, { @@ -163644,29 +164878,29 @@ "type": "string" }, { - "description": "true if NetScaler device is provisioned to be a GSLB service provider", - "name": "gslbprovider", + "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": "device name", + "name": "lbdevicename", "type": "string" }, { - "description": "the physical network to which this netscaler device belongs to", - "name": "physicalnetworkid", - "type": "string" + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" }, { - "description": "device state", - "name": "lbdevicestate", - "type": "string" + "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" } ] }, @@ -163708,35 +164942,35 @@ "related": "", "response": [ { - "description": "Source of the counter.", - "name": "source", + "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "zone id of counter", + "name": "zoneid", "type": "string" }, { - "description": "Provider of the counter.", - "name": "provider", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "Value in case of snmp or other specific counters.", - "name": "value", + "description": "Source of the counter.", + "name": "source", "type": "string" }, + {}, { - "description": "zone id of counter", - "name": "zoneid", + "description": "Provider of the counter.", + "name": "provider", "type": "string" }, { @@ -163745,9 +164979,9 @@ "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Value in case of snmp or other specific counters.", + "name": "value", + "type": "string" } ] }, @@ -163763,18 +164997,18 @@ "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", + "type": "string" + }, + {} ] }, { @@ -163793,40 +165027,46 @@ ], "related": "", "response": [ + {}, { - "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 host agents this management server is responsible for", - "name": "agents", - "type": "list" + "description": "Indicates whether CloudStack is ready to shutdown", + "name": "readyforshutdown", + "type": "boolean" }, { - "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 CloudStack is ready to shutdown", - "name": "readyforshutdown", + "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 UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "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 host agents this management server is responsible for", + "name": "agents", + "type": "list" }, { "description": "The id of the management server", @@ -163834,16 +165074,10 @@ "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" + "description": "the state of the management server", + "name": "state", + "type": "state" }, - {}, {} ], "since": "4.19.0" @@ -163854,76 +165088,70 @@ "name": "addCluster", "params": [ { - "description": "the URL", + "description": "type of the cluster: CloudManaged, ExternalManaged", "length": 255, - "name": "url", - "required": false, + "name": "clustertype", + "required": true, "type": "string" }, { - "description": "the password for the VSM associated with this cluster", + "description": "the URL", "length": 255, - "name": "vsmpassword", + "name": "url", "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": "the Pod ID for the host", - "length": 255, - "name": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" - }, - { - "description": "type of the cluster: CloudManaged, ExternalManaged", + "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", "length": 255, - "name": "clustertype", - "required": true, + "name": "arch", + "required": false, + "since": "4.20", "type": "string" }, { - "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "description": "Ovm3 native pooling enabled for cluster", "length": 255, - "name": "publicvswitchname", + "name": "ovm3pool", "required": false, "type": "string" }, { - "description": "the username for the cluster", + "description": "UUID of the extension", "length": 255, - "name": "username", + "name": "extensionid", + "related": "listExtensions", "required": false, - "type": "string" + "since": "4.21.0", + "type": "uuid" }, { - "description": "the password for the host", + "description": "the password for the VSM associated with this cluster", "length": 255, - "name": "password", + "name": "vsmpassword", "required": false, "type": "string" }, { - "description": "Allocation state of this cluster for allocation of new resources", + "description": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", "length": 255, - "name": "allocationstate", + "name": "guestvswitchname", "required": false, "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", + "description": "the username for the cluster", "length": 255, - "name": "externaldetails", + "name": "username", "required": false, - "since": "4.21.0", - "type": "map" + "type": "string" }, { "description": "the Zone ID for the cluster", @@ -163934,35 +165162,24 @@ "type": "uuid" }, { - "description": "UUID of the extension", - "length": 255, - "name": "extensionid", - "related": "listExtensions", - "required": false, - "since": "4.21.0", - "type": "uuid" - }, - { - "description": "comma separated list of storage access groups for the hosts in the cluster", + "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": "storageaccessgroups", + "name": "publicvswitchtype", "required": false, - "since": "4.21.0", - "type": "list" + "type": "string" }, { - "description": "Ovm3 native pooling enabled for cluster", + "description": "Allocation state of this cluster for allocation of new resources", "length": 255, - "name": "ovm3pool", + "name": "allocationstate", "required": false, "type": "string" }, { - "description": "the CPU arch of the cluster. Valid options are: x86_64, aarch64", + "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", "length": 255, - "name": "arch", - "required": false, - "since": "4.20", + "name": "hypervisor", + "required": true, "type": "string" }, { @@ -163973,11 +165190,12 @@ "type": "string" }, { - "description": "Ovm3 vip to use for pool (and cluster)", + "description": "comma separated list of storage access groups for the hosts in the cluster", "length": 255, - "name": "ovm3vip", + "name": "storageaccessgroups", "required": false, - "type": "string" + "since": "4.21.0", + "type": "list" }, { "description": "Ovm3 native OCFS2 clustering enabled for cluster", @@ -163986,6 +165204,13 @@ "required": false, "type": "string" }, + { + "description": "Ovm3 vip to use for pool (and cluster)", + "length": 255, + "name": "ovm3vip", + "required": false, + "type": "string" + }, { "description": "the username for the VSM associated with this cluster", "length": 255, @@ -163994,55 +165219,78 @@ "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": "Name of virtual switch used for guest traffic in the cluster. This would override zone wide traffic label setting.", + "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": "guestvswitchname", + "name": "externaldetails", "required": false, - "type": "string" + "since": "4.21.0", + "type": "map" }, { - "description": "hypervisor type of the cluster: XenServer,KVM,VMware,Hyperv,BareMetal,Simulator,Ovm3,External", + "description": "the cluster name", "length": 255, - "name": "hypervisor", + "name": "clustername", "required": true, "type": "string" }, { - "description": "the cluster name", + "description": "the Pod ID for the host", "length": 255, - "name": "clustername", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, + "type": "uuid" + }, + { + "description": "Name of virtual switch used for public traffic in the cluster. This would override zone wide traffic label setting.", + "length": 255, + "name": "publicvswitchname", + "required": false, "type": "string" } ], "related": "", "response": [ { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the cluster name", + "name": "name", "type": "string" }, - {}, { - "description": "The memory overcommit ratio of the cluster", - "name": "memoryovercommitratio", + "description": "the allocation state of the cluster", + "name": "allocationstate", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the allocation state of the cluster", - "name": "allocationstate", + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", + "type": "string" + }, + { + "description": "CPU Arch of the hosts in the cluster", + "name": "arch", + "type": "string" + }, + { + "description": "The cpu overcommit ratio of the cluster", + "name": "cpuovercommitratio", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { @@ -164051,74 +165299,85 @@ "type": "string" }, { - "description": "whether this cluster is managed by cloudstack", - "name": "managedstate", + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the Pod ID of the cluster", + "name": "podid", "type": "string" }, + {}, { - "description": "the cluster ID", - "name": "id", + "description": "the type of the cluster", + "name": "clustertype", "type": "string" }, { - "description": "The cpu overcommit ratio of the cluster", - "name": "cpuovercommitratio", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "description": "Ovm3 VIP to use for pooling and/or clustering", + "name": "ovm3vip", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", + "description": "the Pod name of the cluster", + "name": "podname", + "type": "string" + }, + { + "description": "whether this cluster is managed by cloudstack", + "name": "managedstate", + "type": "string" + }, + { + "description": "the Zone name of the cluster", + "name": "zonename", "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" }, {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the hypervisor type of the cluster", + "name": "hypervisortype", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "the cluster ID", + "name": "id", "type": "string" }, { - "description": "the Zone name of the cluster", - "name": "zonename", + "description": "The name of extension for this cluster", + "name": "extensionname", "type": "string" }, { - "description": "the cluster name", - "name": "name", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { "description": "the capacity of the Cluster", "name": "capacity", "response": [ { - "description": "the capacity currently in allocated", - "name": "capacityallocated", - "type": "long" + "description": "the Zone ID", + "name": "zoneid", + "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", + "description": "the total capacity available", + "name": "capacitytotal", "type": "long" }, { @@ -164127,43 +165386,43 @@ "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "The tag for the capacity type", + "name": "tag", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster name", - "name": "clustername", - "type": "string" + "description": "the capacity currently in allocated", + "name": "capacityallocated", + "type": "long" }, { - "description": "the total capacity available", - "name": "capacitytotal", - "type": "long" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the Cluster ID", + "name": "clusterid", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the capacity name", + "name": "name", "type": "string" }, { @@ -164172,47 +165431,22 @@ "type": "string" }, { - "description": "the Zone name", - "name": "zonename", + "description": "the Pod ID", + "name": "podid", "type": "string" } ], "type": "list" }, { - "description": "CPU Arch of the hosts in the cluster", - "name": "arch", - "type": "string" - }, - { - "description": "the Pod ID of the cluster", - "name": "podid", - "type": "string" - }, - { - "description": "the hypervisor type of the cluster", - "name": "hypervisortype", - "type": "string" - }, - { - "description": "the Pod name of the cluster", - "name": "podname", - "type": "string" - }, - { - "description": "Ovm3 VIP to use for pooling and/or clustering", - "name": "ovm3vip", - "type": "string" - }, - { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "The memory overcommit ratio of the cluster", + "name": "memoryovercommitratio", "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" } ] }, @@ -164231,27 +165465,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 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" } ] }, @@ -164272,41 +165506,21 @@ "description": "Virtual Machine ID", "length": 255, "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", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,removeNicFromVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", "required": true, "type": "uuid" } ], - "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", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", "response": [ { - "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": "the memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { @@ -164314,152 +165528,156 @@ "name": "deleteprotection", "type": "boolean" }, - {}, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the project id of the vm", + "name": "projectid", "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": "list of affinity groups associated with the virtual machine", - "name": "affinitygroup", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the ID of the affinity group", - "name": "id", - "type": "string" - }, - { - "description": "the type of the affinity group", - "name": "type", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "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 project name of the affinity group", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the project name where tag belongs to", + "name": "project", "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": "the domain name of the affinity group", - "name": "domain", + "description": "tag value", + "name": "value", "type": "string" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "customer associated with the tag", + "name": "customer", "type": "string" }, { - "description": "virtual machine IDs associated with this affinity group", - "name": "virtualmachineIds", - "type": "list" + "description": "tag key name", + "name": "key", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the account associated with the tag", + "name": "account", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "id of the resource", + "name": "resourceid", "type": "string" } ], "type": "set" }, { - "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": "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", + "type": "long" + }, { "description": "Name of AutoScale VM group", "name": "autoscalevmgroupname", "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", + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "CPU arch of the VM", + "name": "arch", + "type": "string" }, { - "description": "an optional field whether to the display the vm to the end user or not.", - "name": "displayvm", + "description": "true if the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "the user's name who deployed the virtual machine", + "name": "username", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" + "description": "VNF details", + "name": "vnfdetails", + "type": "map" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the ID of the virtual machine", + "name": "id", "type": "string" }, { @@ -164468,471 +165686,138 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" }, { - "description": "the account associated with the virtual machine", - "name": "account", + "description": "the ID of the availability zone for the virtual machine", + "name": "zoneid", "type": "string" }, - {}, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", + "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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": "the read (IO) of disk on the VM", + "name": "diskioread", + "type": "long" }, { - "description": "VNF details", - "name": "vnfdetails", - "type": "map" + "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 VM's disk write in KiB", + "name": "diskkbswrite", + "type": "long" }, { - "description": "public IP address id associated with vm via Static nat rule", - "name": "publicip", + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" + }, + { + "description": "ID of AutoScale VM group", + "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the internal memory (KiB) that's free in VM or zero if it can not be calculated", + "name": "memoryintfreekbs", "type": "long" }, { - "description": "the incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "description": "the pool type of the virtual machine", + "name": "pooltype", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", + "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": "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 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", + "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "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": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { - "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": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" + }, + { + "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 type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "Guest vm Boot Type", - "name": "boottype", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "list of security groups associated with the virtual machine", - "name": "securitygroup", - "response": [ - { - "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 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 description of the security group", - "name": "description", - "type": "string" - }, - { - "description": "the list of resource tags associated with the rule", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "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 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": "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 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 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 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 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 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 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 ID of the security group", - "name": "id", - "type": "string" - }, - { - "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 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": "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 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 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": "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": "id of the resource", - "name": "resourceid", - "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": "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" - } - ], - "type": "set" - } - ], - "type": "set" - } - ], - "type": "set" + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", + "type": "string" }, { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { @@ -164941,132 +165826,132 @@ "type": "string" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the account associated with the virtual machine", + "name": "account", "type": "string" }, { - "description": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ { - "description": "the gateway of the nic", - "name": "gateway", + "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", + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { - "description": "the type of the nic", - "name": "type", + "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", + "name": "nsxlogicalswitch", "type": "string" }, { - "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 vpc to which the nic belongs", - "name": "vpcid", + "description": "name of the vpc to which the nic belongs", + "name": "vpcname", "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 Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the traffic type of the nic", + "name": "traffictype", + "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the name of the corresponding network", - "name": "networkname", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "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 cidr of IPv6 network", - "name": "ip6cidr", + "description": "the ID of the nic", + "name": "id", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "description": "the broadcast uri of the nic", + "name": "broadcasturi", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", + "description": "the extra dhcp options on the nic", + "name": "extradhcpoption", "type": "list" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "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": "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": "the name of the corresponding network", + "name": "networkname", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the ID of the corresponding network", + "name": "networkid", "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 ID of the nic", - "name": "id", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -165080,168 +165965,148 @@ "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": "the ID of the corresponding network", - "name": "networkid", - "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { - "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": "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 netmask of the nic", + "name": "netmask", "type": "string" } ], "type": "set" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", - "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 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", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", - "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 hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "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 name of the virtual machine", - "name": "name", + "description": "the ID of the ISO attached to the virtual machine", + "name": "isoid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", - "type": "string" + "description": "NICs of the VNF appliance", + "name": "vnfnics", + "type": "list" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "the amount of the vm's CPU currently used", - "name": "cpuused", + "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", - "type": "string" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the user's name who deployed the virtual machine", - "name": "username", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": "the ID of the backup offering of the virtual machine", - "name": "backupofferingid", + "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 ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "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 virtual network for the service offering", - "name": "forvirtualnetwork", - "type": "boolean" + "description": "State of the Service from LB rule", + "name": "servicestate", + "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 gpu card to which service offering is linked", - "name": "gpucardid", + "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 ISO attached to the virtual machine", - "name": "isoname", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the group name of the virtual machine", + "name": "group", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the name of the domain in which the virtual machine exists", + "name": "domain", + "type": "string" }, { "description": "device ID of the root volume", @@ -165249,191 +166114,560 @@ "type": "long" }, { - "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 name of the service offering of the virtual machine", - "name": "serviceofferingname", - "type": "string" + "description": "the VM's disk read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", "type": "long" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", - "type": "string" + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" }, { - "description": "the video RAM size in MB", - "name": "videoram", - "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": "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 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 description of the affinity group", + "name": "description", + "type": "string" + }, + { + "description": "the project name of the affinity group", + "name": "project", + "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 account owning the affinity group", + "name": "account", + "type": "string" + }, + { + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" + } + ], + "type": "set" }, { - "description": "NICs of the VNF appliance", - "name": "vnfnics", - "type": "list" + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", + "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", - "type": "integer" + "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 target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "description": "User VM type", + "name": "vmtype", "type": "string" }, + { + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, { "description": "the maximum Y resolution", "name": "maxresolutiony", "type": "long" }, { - "description": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, - { - "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", + "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", + "type": "integer" + }, { - "description": "the list of resource tags associated", - "name": "tags", + "description": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" + }, + { + "description": "list of security groups associated with the virtual machine", + "name": "securitygroup", "response": [ { - "description": "id of the resource", - "name": "resourceid", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "the project name where tag belongs to", - "name": "project", + "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": "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": "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": "the domain associated with the tag", + "name": "domain", + "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" + } + ], + "type": "set" + }, + { + "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 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 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", + "type": "string" + }, + { + "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 ID of the security group", + "name": "id", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "customer associated with the tag", - "name": "customer", + "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": "resource type", - "name": "resourcetype", + "description": "the domain name of the security group", + "name": "domain", "type": "string" }, { - "description": "the project id the tag belongs to", + "description": "the project id of the group", "name": "projectid", "type": "string" }, { - "description": "the domain associated with the tag", - "name": "domain", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "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 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": "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": "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": "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" + } + ], + "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": "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" + } + ], + "type": "set" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "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", + "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": "path of the Domain associated with the tag", + "name": "domainpath", + "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": "resource type", + "name": "resourcetype", + "type": "string" + } + ], + "type": "set" }, { - "description": "tag key name", - "name": "key", + "description": "the description of the security group", + "name": "description", "type": "string" } ], "type": "set" }, + {}, { - "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": "the VM's primary IP address", - "name": "ipaddress", + "description": "the id of userdata used for the VM", + "name": "userdataid", "type": "string" }, { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "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 name of the ISO attached to the virtual machine", + "name": "isoname", + "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": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "the VM's primary IP address", + "name": "ipaddress", "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 name of the host for the virtual machine", - "name": "hostname", + "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": "Base64 string containing the user data", + "name": "userdata", + "type": "string" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", - "type": "long" + "description": "the user's ID who deployed the virtual machine", + "name": "userid", + "type": "string" + }, + { + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" } ] }, @@ -165443,40 +166677,34 @@ "name": "listDedicatedHosts", "params": [ { - "description": "the ID of the domain associated with the host", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, - { - "description": "List by keyword", + "description": "the name of the account associated with the host. Must be used with domainId.", "length": 255, - "name": "keyword", + "name": "account", "required": false, "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, { - "description": "the name of the account associated with the host. Must be used with domainId.", + "description": "the ID of the domain associated with the host", "length": 255, - "name": "account", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "", + "description": "the ID of the host", "length": 255, - "name": "pagesize", + "name": "hostid", + "related": "reconnectHost", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "list dedicated hosts by affinity group", @@ -165487,36 +166715,41 @@ "type": "uuid" }, { - "description": "the ID of the host", + "description": "List by keyword", "length": 255, - "name": "hostid", - "related": "reconnectHost", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", "response": [ { - "description": "the domain ID of the host", - "name": "domainid", + "description": "the Account ID of the host", + "name": "accountid", "type": "string" }, - {}, { - "description": "the ID of the dedicated resource", - "name": "id", + "description": "the domain ID of the host", + "name": "domainid", "type": "string" }, { - "description": "the Dedication Affinity Group ID of the host", - "name": "affinitygroupid", + "description": "the name of the host", + "name": "hostname", "type": "string" }, { - "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 UUID of the latest async job acting on this object", @@ -165524,18 +166757,19 @@ "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 name of the host", - "name": "hostname", + "description": "the ID of the dedicated resource", + "name": "id", "type": "string" }, + {}, { - "description": "the Account ID of the host", - "name": "accountid", + "description": "the Dedication Affinity Group ID of the host", + "name": "affinitygroupid", "type": "string" }, {} @@ -165547,26 +166781,32 @@ "name": "getUploadParamsForIso", "params": [ { - "description": "true if you want this ISO to be featured", + "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", "length": 255, - "name": "isfeatured", + "name": "ispublic", "required": false, "type": "boolean" }, { - "description": "true if you want to register the ISO to be publicly available to all users, false otherwise.", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", "length": 255, - "name": "ispublic", + "name": "format", + "required": true, + "type": "string" + }, + { + "description": "true if you want this ISO to be featured", + "length": 255, + "name": "isfeatured", "required": false, "type": "boolean" }, { - "description": "Upload volume/template/iso for the project", + "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": "projectid", - "related": "", + "name": "checksum", "required": false, - "type": "uuid" + "type": "string" }, { "description": "the ID of the zone the volume/template/iso is to be hosted on", @@ -165577,19 +166817,11 @@ "type": "uuid" }, { - "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", - "length": 255, - "name": "format", - "required": true, - "type": "string" - }, - { - "description": "an optional domainId. If the account parameter is used, domainId must also be used.", + "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "bootable", "required": false, - "type": "uuid" + "type": "boolean" }, { "description": "the name of the volume/template/iso", @@ -165599,11 +166831,11 @@ "type": "string" }, { - "description": "true if the ISO or its derivatives are extractable; default is false", - "length": 255, - "name": "isextractable", + "description": "the display text of the ISO. This is usually used for display purposes.", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { "description": "an optional accountName. Must be used with domainId.", @@ -165613,18 +166845,27 @@ "type": "string" }, { - "description": "true if this ISO is bootable. If not passed explicitly its assumed to be true", + "description": "an optional domainId. If the account parameter is used, domainId must also be used.", "length": 255, - "name": "bootable", + "name": "domainid", + "related": "listDomains", "required": false, - "type": "boolean" + "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": "Upload volume/template/iso for the project", "length": 255, - "name": "checksum", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" + }, + { + "description": "true if the ISO or its derivatives are extractable; default is false", + "length": 255, + "name": "isextractable", + "required": false, + "type": "boolean" }, { "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", @@ -165633,53 +166874,46 @@ "related": "", "required": false, "type": "uuid" - }, - { - "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", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "signature to be sent in the POST request.", - "name": "signature", + "description": "POST url to upload the file to", + "name": "postURL", + "type": "url" + }, + { + "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" }, { - "description": "POST url to upload the file to", - "name": "postURL", - "type": "url" + "description": "encrypted data to be sent in the POST request.", + "name": "metadata", + "type": "string" }, + {}, { "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" - }, {} ], "since": "4.13" @@ -165689,13 +166923,6 @@ "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, @@ -165703,27 +166930,34 @@ "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 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": "Storage URL to download retrieve diagnostics data files", + "name": "url", + "type": "string" + }, + {} ], "since": "4.14.0.0" }, @@ -165732,14 +166966,6 @@ "isasync": true, "name": "deleteAutoScaleVmGroup", "params": [ - { - "description": "the ID of the autoscale group", - "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "true if all VMs have to be cleaned up, false otherwise", "length": 255, @@ -165747,31 +166973,39 @@ "required": false, "since": "4.18.0", "type": "boolean" + }, + { + "description": "the ID of the autoscale group", + "length": 255, + "name": "id", + "related": "", + "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", "type": "boolean" - } + }, + {}, + {} ] }, { @@ -165782,31 +167016,31 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "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": "", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "List by keyword", + "description": "the Physical Network ID", "length": 255, - "name": "keyword", + "name": "physicalnetworkid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { "description": "Palo Alto firewall device ID", @@ -165820,43 +167054,34 @@ "related": "", "response": [ { - "description": "device id of the Palo Alto firewall", - "name": "fwdeviceid", + "description": "the public interface of the external firewall", + "name": "publicinterface", "type": "string" }, + {}, { - "description": "the timeout (in seconds) for requests to the external firewall", - "name": "timeout", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the zone ID of the external firewall", - "name": "zoneid", + "description": "name of the provider", + "name": "provider", "type": "string" }, { - "description": "the usage interface of the external firewall", - "name": "usageinterface", + "description": "the username that's used to log in to the external firewall", + "name": "username", "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 private interface of the external firewall", - "name": "privateinterface", + "description": "the timeout (in seconds) for requests to the external firewall", + "name": "timeout", "type": "string" }, { - "description": "device state", - "name": "fwdevicestate", + "description": "the physical network to which this Palo Alto firewall belongs to", + "name": "physicalnetworkid", "type": "string" }, { @@ -165865,40 +167090,39 @@ "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": "device name", - "name": "fwdevicename", - "type": "string" + "description": "device capacity", + "name": "fwdevicecapacity", + "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "device state", + "name": "fwdevicestate", "type": "string" }, {}, - {}, { - "description": "the username that's used to log in to the external firewall", - "name": "username", + "description": "the zone ID of the external firewall", + "name": "zoneid", "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "the number of times to retry requests to the external firewall", + "name": "numretries", "type": "string" }, { - "description": "the public interface of the external firewall", - "name": "publicinterface", + "description": "device name", + "name": "fwdevicename", "type": "string" }, { - "description": "the physical network to which this Palo Alto firewall belongs to", - "name": "physicalnetworkid", + "description": "the private interface of the external firewall", + "name": "privateinterface", "type": "string" }, { @@ -165907,8 +167131,18 @@ "type": "string" }, { - "description": "the number of times to retry requests to the external firewall", - "name": "numretries", + "description": "the private security zone of the external firewall", + "name": "privatezone", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "device id of the Palo Alto firewall", + "name": "fwdeviceid", "type": "string" } ] @@ -165919,19 +167153,19 @@ "name": "updateLoadBalancerRule", "params": [ { - "description": "the ID of the load balancer rule to update", + "description": "The protocol for the LB", "length": 255, - "name": "id", - "related": "", - "required": true, - "type": "uuid" + "name": "protocol", + "required": false, + "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "an optional field, whether to the display the rule to the end user or not", "length": 255, - "name": "name", + "name": "fordisplay", "required": false, - "type": "string" + "since": "4.4", + "type": "boolean" }, { "description": "load balancer algorithm (source, roundrobin, leastconn)", @@ -165941,19 +167175,20 @@ "type": "string" }, { - "description": "The protocol for the LB", + "description": "an optional field, in case you want to set a custom id to the resource. Allowed to Root Admins only", "length": 255, - "name": "protocol", + "name": "customid", "required": false, + "since": "4.4", "type": "string" }, { - "description": "an optional field, whether to the display the rule to the end user or not", + "description": "the ID of the load balancer rule to update", "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" + "name": "id", + "related": "", + "required": true, + "type": "uuid" }, { "description": "the description of the load balancer rule", @@ -165963,30 +167198,72 @@ "type": "string" }, { - "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, - "since": "4.4", "type": "string" + }, + { + "description": "the cidr list to forward traffic from", + "length": 255, + "name": "cidrlist", + "required": false, + "since": "4.22", + "type": "list" } ], "related": "listLoadBalancerRules", "response": [ { - "description": "the public ip address id", - "name": "publicipid", + "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the project id of the load balancer", + "name": "projectid", + "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": "is rule for display to the regular user", + "name": "fordisplay", + "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 ID of the load balancer rule", "name": "domainid", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the private port", + "name": "privateport", "type": "string" }, { @@ -165995,24 +167272,45 @@ "type": "string" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the public ip address id", + "name": "publicipid", "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 algorithm (source, roundrobin, leastconn)", + "name": "algorithm", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", + "type": "string" + }, + { + "description": "the id of the guest network the lb rule belongs to", + "name": "networkid", + "type": "string" + }, + { + "description": "the name of the zone the load balancer rule belongs to", + "name": "zonename", "type": "string" }, + {}, { "description": "the list of resource tags associated with load balancer", "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": "the domain associated with the tag", "name": "domain", @@ -166024,18 +167322,13 @@ "type": "string" }, { - "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 project name where tag belongs to", - "name": "project", + "description": "the project id the tag belongs to", + "name": "projectid", "type": "string" }, { @@ -166044,13 +167337,13 @@ "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": "the project name where tag belongs to", + "name": "project", "type": "string" }, { @@ -166059,57 +167352,21 @@ "type": "string" }, { - "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" } ], "type": "list" }, - { - "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", - "type": "string" - }, - { - "description": "the description of the load balancer", - "name": "description", - "type": "string" - }, { "description": "the load balancer rule ID", "name": "id", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", - "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 id of the zone the rule belongs to", - "name": "zoneid", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { @@ -166118,18 +167375,8 @@ "type": "string" }, { - "description": "the name of the load balancer", - "name": "name", - "type": "string" - }, - { - "description": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { @@ -166138,18 +167385,13 @@ "type": "string" }, { - "description": "the project name of the load balancer", - "name": "project", - "type": "string" - }, - { - "description": "the account of the load balancer rule", - "name": "account", + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", "type": "string" }, { - "description": "the private port", - "name": "privateport", + "description": "the project name of the load balancer", + "name": "project", "type": "string" } ] @@ -166159,14 +167401,6 @@ "isasync": false, "name": "enableAccount", "params": [ - { - "description": "Enables specified account in this domain.", - "length": 255, - "name": "domainid", - "related": "listDomains", - "required": false, - "type": "uuid" - }, { "description": "Enables specified account.", "length": 255, @@ -166181,34 +167415,32 @@ "related": "enableAccount,listAccounts", "required": false, "type": "uuid" + }, + { + "description": "Enables specified account in this domain.", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" } ], "related": "listAccounts", "response": [ { - "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": "details for the account", + "name": "accountdetails", + "type": "map" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the total primary storage space (in GiB) the account can own", + "name": "primarystoragelimit", "type": "string" }, { - "description": "the total number of cpu cores the account can own", - "name": "cpulimit", - "type": "string" + "description": "the total number of virtual machines deployed by this account", + "name": "vmtotal", + "type": "long" }, { "description": "the date when this account was created", @@ -166216,29 +167448,29 @@ "type": "date" }, { - "description": "the total number of public ip addresses allocated for this account", - "name": "iptotal", - "type": "long" + "description": "the total secondary storage space (in GiB) owned by account", + "name": "secondarystoragetotal", + "type": "float" }, { - "description": "the total volume available for this account", - "name": "volumeavailable", + "description": "the total number of networks the account can own", + "name": "networklimit", "type": "string" }, { - "description": "the total number of projects being administrated by this account", - "name": "projecttotal", + "description": "the total number of snapshots stored by this account", + "name": "snapshottotal", "type": "long" }, { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", + "description": "the total number of cpu cores owned by account", + "name": "cputotal", "type": "long" }, { - "description": "the total number of virtual machines stopped for this account", - "name": "vmstopped", - "type": "integer" + "description": "true if account is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { "description": "the current status of the latest async job acting on this object", @@ -166246,53 +167478,109 @@ "type": "integer" }, { - "description": "true if the account requires cleanup", - "name": "iscleanuprequired", - "type": "boolean" + "description": "id of the Domain the account belongs to", + "name": "domainid", + "type": "string" }, { - "description": "the total backup storage space (in GiB) available to the account", - "name": "backupstorageavailable", + "description": "the total number of templates which can be created by this account", + "name": "templatelimit", "type": "string" }, { - "description": "the total number of networks available to be created for this account", - "name": "networkavailable", + "description": "the total number of projects being administrated by this account", + "name": "projecttotal", + "type": "long" + }, + { + "description": "the total number of gpus available to be created for this account", + "name": "gpuavailable", "type": "string" }, { - "description": "the total number of buckets available to this account", - "name": "bucketavailable", + "description": "the total backup storage space (in GiB) the account can own", + "name": "backupstoragelimit", "type": "string" }, { - "description": "true if account is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the name of the account", + "name": "name", + "type": "string" }, { - "description": "the total number of public ip addresses available for this account to acquire", - "name": "ipavailable", + "description": "the total number of vpcs the account can own", + "name": "vpclimit", "type": "string" }, { - "description": "the total number of virtual machines running for this account", - "name": "vmrunning", - "type": "integer" + "description": "the total number of templates available to be created by this account", + "name": "templateavailable", + "type": "string" }, { - "description": "the total backup storage space (in GiB) owned by the account", - "name": "backupstoragetotal", + "description": "true if the account requires cleanup", + "name": "iscleanuprequired", + "type": "boolean" + }, + { + "description": "the total number of gpus owned by account", + "name": "gputotal", + "type": "long" + }, + { + "description": "the total number of backups stored by this account", + "name": "backuptotal", "type": "long" }, + { + "description": "the total object storage space (in GiB) available to the account", + "name": "objectstorageavailable", + "type": "string" + }, + {}, + { + "description": "the total number of snapshots available for this account", + "name": "snapshotavailable", + "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 name of the account", - "name": "name", + "description": "the total number of virtual machines stopped for this account", + "name": "vmstopped", + "type": "integer" + }, + { + "description": "the total primary storage space (in GiB) owned by account", + "name": "primarystoragetotal", + "type": "long" + }, + { + "description": "the default zone of the account", + "name": "defaultzoneid", + "type": "string" + }, + { + "description": "the total number of vpcs available to be created for this account", + "name": "vpcavailable", + "type": "string" + }, + { + "description": "The tagged resource limit and count for the account", + "name": "taggedresources", + "type": "list" + }, + { + "description": "the total number of virtual machines available for this account to acquire", + "name": "vmavailable", + "type": "string" + }, + { + "description": "the total number of projects available for administration by this account", + "name": "projectavailable", "type": "string" }, { @@ -166301,13 +167589,13 @@ "type": "string" }, { - "description": "the network domain", - "name": "networkdomain", + "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 buckets which can be stored by this account", + "name": "bucketlimit", "type": "string" }, { @@ -166316,69 +167604,90 @@ "type": "list" }, { - "description": "the total memory (in MB) owned by account", - "name": "memorytotal", + "description": "the total volume being used by this account", + "name": "volumetotal", "type": "long" }, + { + "description": "the total volume which can be used by this account", + "name": "volumelimit", + "type": "string" + }, + { + "description": "the total number of networks available to be created for this account", + "name": "networkavailable", + "type": "string" + }, { "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", + "description": "the total number of virtual machines that can be deployed by this account", + "name": "vmlimit", "type": "string" }, { - "description": "the total number of templates available to be created by this account", - "name": "templateavailable", + "description": "the total number of backups which can be stored by this account", + "name": "backuplimit", "type": "string" }, { - "description": "the total volume which can be used by this account", - "name": "volumelimit", + "description": "the total volume available for this account", + "name": "volumeavailable", "type": "string" }, { - "description": "the total number of snapshots available for this account", - "name": "snapshotavailable", + "description": "the total number of cpu cores available to be created for this account", + "name": "cpuavailable", "type": "string" }, { - "description": "the total primary storage space (in GiB) the account can own", - "name": "primarystoragelimit", + "description": "the total memory (in MB) available to be created for this account", + "name": "memoryavailable", "type": "string" }, { - "description": "the total number of templates which have been created by this account", - "name": "templatetotal", + "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", + "name": "roletype", + "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 number of gpus available to be created for this account", - "name": "gpuavailable", + "description": "the network domain", + "name": "networkdomain", "type": "string" }, { - "description": "the total number of vpcs the account can own", - "name": "vpclimit", + "description": "the total primary storage space (in GiB) available to be used for this account", + "name": "primarystorageavailable", "type": "string" }, { - "description": "the default zone of the account", - "name": "defaultzoneid", + "description": "the total backup storage space (in GiB) available to the account", + "name": "backupstorageavailable", "type": "string" }, { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" + "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", - "type": "long" + "description": "path of the Domain the account belongs to", + "name": "domainpath", + "type": "string" }, { "description": "the id of the account", @@ -166386,140 +167695,163 @@ "type": "string" }, { - "description": "id of the Domain the account belongs to", - "name": "domainid", + "description": "the total number of network traffic bytes received", + "name": "receivedbytes", + "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 volume being used by this account", - "name": "volumetotal", + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" + }, + { + "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 number of public ip addresses allocated for this account", + "name": "iptotal", + "type": "long" }, { - "description": "path of the Domain the account belongs to", - "name": "domainpath", + "description": "the total memory (in MB) the account can own", + "name": "memorylimit", "type": "string" }, { - "description": "the total number of buckets which can be stored by this account", - "name": "bucketlimit", - "type": "string" + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", + "type": "long" }, { - "description": "name of the Domain the account belongs to", - "name": "domain", - "type": "string" + "description": "the total backup storage space (in GiB) owned by the account", + "name": "backupstoragetotal", + "type": "long" }, { - "description": "the total number of public ip addresses this account can acquire", - "name": "iplimit", + "description": "the name of the role", + "name": "rolename", "type": "string" }, { - "description": "the total number of vpcs available to be created for this account", - "name": "vpcavailable", - "type": "string" + "description": "the total memory (in MB) owned by account", + "name": "memorytotal", + "type": "long" }, { - "description": "the total number of virtual machines available for this account to acquire", - "name": "vmavailable", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "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": "the total memory (in MB) the account can own", - "name": "memorylimit", + "description": "the total number of gpus the account can own", + "name": "gpulimit", "type": "string" }, { - "description": "the total number of backups which can be stored by this account", - "name": "backuplimit", + "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", + "description": "the total number of backups available to this account", + "name": "backupavailable", "type": "string" }, { - "description": "the total number of cpu cores available to be created for this account", - "name": "cpuavailable", + "description": "the total number of projects the account can own", + "name": "projectlimit", "type": "string" }, { - "description": "the total number of virtual machines that can be deployed by this account", - "name": "vmlimit", - "type": "string" + "description": "account type (admin, domain-admin, user)", + "name": "accounttype", + "type": "integer" }, { "description": "the total secondary storage space (in GiB) the account can own", "name": "secondarystoragelimit", "type": "string" }, - {}, - { - "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 user name", + "name": "username", + "type": "string" + }, + { + "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 timezone user was created in", + "name": "timezone", + "type": "string" + }, { "description": "the user lastname", "name": "lastname", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "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": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the user name", - "name": "username", + "description": "the type of the role", + "name": "roletype", "type": "string" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "the domain ID of the user", - "name": "domainid", - "type": "string" + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", + "type": "boolean" }, { - "description": "the user email address", - "name": "email", + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the domain name of the user", - "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 source type of the user in lowercase, such as native, ldap, saml2", @@ -166527,9 +167859,14 @@ "type": "string" }, { - "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": "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 type of the user", @@ -166537,48 +167874,38 @@ "type": "integer" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the account name of the user", + "name": "account", "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 api key of the user", - "name": "apikey", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "true if user is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the user state", + "name": "state", + "type": "string" }, { - "description": "the type of the role", - "name": "roletype", + "description": "the domain ID of the user", + "name": "domainid", "type": "string" }, { @@ -166587,122 +167914,37 @@ "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the name of the role", + "name": "rolename", "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" } ], "type": "list" }, { - "description": "the total backup storage space (in GiB) the account can own", - "name": "backupstoragelimit", - "type": "string" - }, - { - "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 backups available to this account", - "name": "backupavailable", + "description": "the state of the account", + "name": "state", "type": "string" }, { - "description": "the total primary storage space (in GiB) owned by account", - "name": "primarystoragetotal", + "description": "the total number of templates which have been created by this account", + "name": "templatetotal", "type": "long" }, { - "description": "The tagged resource limit and count for the account", - "name": "taggedresources", - "type": "list" - }, - { - "description": "the total number of gpus the account can own", - "name": "gpulimit", + "description": "the total number of snapshots which can be stored by this account", + "name": "snapshotlimit", "type": "string" }, { - "description": "the total number of gpus owned by account", - "name": "gputotal", - "type": "long" - }, - { - "description": "the total number of virtual machines deployed by this account", - "name": "vmtotal", - "type": "long" - }, - { - "description": "the total number of networks owned by account", - "name": "networktotal", - "type": "long" - }, - { - "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", + "description": "the total number of buckets stored by this account", + "name": "buckettotal", "type": "long" }, - { - "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 object storage space (in GiB) owned by the account", "name": "objectstoragetotal", "type": "long" - }, - { - "description": "the total primary storage space (in GiB) available to be used for this account", - "name": "primarystorageavailable", - "type": "string" - }, - { - "description": "the type of the role (Admin, ResourceAdmin, DomainAdmin, User)", - "name": "roletype", - "type": "string" - }, - { - "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" } ] }, @@ -166712,11 +167954,11 @@ "name": "changeStoragePoolScope", "params": [ { - "description": "the Id of the storage pool", + "description": "the Id of the cluster to use if scope is being set to Cluster", "length": 255, - "name": "id", + "name": "clusterid", "related": "", - "required": true, + "required": false, "type": "uuid" }, { @@ -166727,27 +167969,27 @@ "type": "string" }, { - "description": "the Id of the cluster to use if scope is being set to Cluster", + "description": "the Id of the storage pool", "length": 255, - "name": "clusterid", + "name": "id", "related": "", - "required": false, + "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": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -166777,9 +168019,9 @@ ], "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" }, {}, { @@ -166794,9 +168036,9 @@ }, {}, { - "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" @@ -166806,6 +168048,13 @@ "isasync": true, "name": "deleteNetwork", "params": [ + { + "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", + "length": 255, + "name": "forced", + "required": false, + "type": "boolean" + }, { "description": "the ID of the network", "length": 255, @@ -166813,33 +168062,26 @@ "related": "createNetwork,updateNetwork,listNetworks", "required": true, "type": "uuid" - }, - { - "description": "Force delete a network. Network will be marked as 'Destroy' even when commands to shutdown and cleanup to the backend fails.", - "length": 255, - "name": "forced", - "required": false, - "type": "boolean" } ], "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", @@ -166864,59 +168106,60 @@ "related": "", "response": [ { - "description": "the CPU speed of the host", - "name": "cpuspeed", - "type": "long" + "description": "the date and time the host was removed", + "name": "removed", + "type": "date" }, { - "description": "the amount of the host's CPU currently allocated in MHz", - "name": "cpuallocatedvalue", - "type": "long" + "description": "the host version", + "name": "version", + "type": "string" }, - {}, { - "description": "the number of CPU sockets on the host", - "name": "cpusockets", - "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", + "description": "Whether the informed tag is a JS interpretable rule or not.", + "name": "istagarule", + "type": "boolean" + }, + { + "description": "comma-separated list of storage access groups on the pod", + "name": "podstorageaccessgroups", "type": "string" }, { - "description": "the date and time the host was last pinged", - "name": "lastpinged", + "description": "the last time this host was annotated", + "name": "lastannotated", "type": "date" }, { - "description": "the OS category ID of the host", - "name": "oscategoryid", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, + {}, + {}, { - "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": "comma-separated list of tags for the host", + "name": "hosttags", "type": "string" }, { - "description": "comma-separated list of storage access groups for the host", - "name": "storageaccessgroups", + "description": "the OS category ID of the host", + "name": "oscategoryid", "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 in MHz", + "name": "cpuallocatedvalue", + "type": "long" }, { - "description": "the virtual machine id for host type ConsoleProxy and SecondaryStorageVM", - "name": "virtualmachineid", + "description": "the amount of the host's CPU currently allocated in percentage", + "name": "cpuallocatedpercentage", "type": "string" }, { @@ -166924,21 +168167,15 @@ "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": "the CPU speed of the host", + "name": "cpuspeed", + "type": "long" }, { - "description": "true if the host supports encryption", - "name": "encryptionsupported", - "type": "boolean" + "description": "the state of the host", + "name": "state", + "type": "status" }, { "description": "the amount of the host's CPU currently allocated", @@ -166946,13 +168183,23 @@ "type": "string" }, { - "description": "the host hypervisor", - "name": "hypervisor", + "description": "The ID of extension for this cluster", + "name": "extensionid", "type": "string" }, { - "description": "comma-separated list of explicit host tags for the host", - "name": "explicithosttags", + "description": "the Zone name of the host", + "name": "zonename", + "type": "string" + }, + { + "description": "the number of CPU sockets on the host", + "name": "cpusockets", + "type": "integer" + }, + { + "description": "the name of the host", + "name": "name", "type": "string" }, { @@ -166961,54 +168208,124 @@ "type": "string" }, { - "description": "comma-separated list of storage access groups on the zone", - "name": "zonestorageaccessgroups", + "description": "capabilities of the host", + "name": "capabilities", "type": "string" }, { - "description": "the OS category name of the host", - "name": "oscategoryname", + "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 after applying the cpu.overprovisioning.factor", + "name": "cpuallocatedwithoverprovisioning", + "type": "string" + }, + { + "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", + "name": "cpuwithoverprovisioning", + "type": "string" + }, + { + "description": "comma-separated list of storage access groups for the host", + "name": "storageaccessgroups", "type": "string" }, + { + "description": "the outgoing network traffic on the host", + "name": "networkkbswrite", + "type": "long" + }, + { + "description": "the date and time the host was created", + "name": "created", + "type": "date" + }, + { + "description": "true if the host supports encryption", + "name": "encryptionsupported", + "type": "boolean" + }, { "description": "the IP address of the host", "name": "ipaddress", "type": "string" }, { - "description": "the Pod ID of the host", - "name": "podid", + "description": "the admin that annotated this host", + "name": "username", "type": "string" }, { - "description": "the cluster ID of the host", - "name": "clusterid", + "description": "the resource state of the host", + "name": "resourcestate", "type": "string" }, { - "description": "the host type", - "name": "type", - "type": "type" + "description": "the Pod name of the host", + "name": "podname", + "type": "string" }, { - "description": "the host version", - "name": "version", + "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 ID of the host", + "name": "id", "type": "string" }, { - "description": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", - "name": "memorytotal", + "description": "the host HA information information", + "name": "hostha", + "type": "hostharesponse" + }, + { + "description": "the cpu average load on the host", + "name": "cpuloadaverage", + "type": "double" + }, + { + "description": "the total disk size of the host", + "name": "disksizetotal", + "type": "long" + }, + { + "description": "events available for the host", + "name": "events", + "type": "string" + }, + { + "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 cluster ID of the host", + "name": "clusterid", + "type": "string" + }, { "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": "the memory total of the host, this parameter is deprecated use memorywithoverprovisioning", + "name": "memorytotal", + "type": "long" }, { "description": "GPU cards present in the host", @@ -167018,11 +168335,6 @@ "description": "the list of enabled vGPUs", "name": "vgpu", "response": [ - { - "description": "Model Name of vGPU", - "name": "vgputype", - "type": "string" - }, { "description": "Maximum displays per user", "name": "maxheads", @@ -167034,8 +168346,13 @@ "type": "long" }, { - "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", - "name": "maxcapacity", + "description": "Model Name of vGPU", + "name": "vgputype", + "type": "string" + }, + { + "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", + "name": "remainingcapacity", "type": "long" }, { @@ -167054,8 +168371,8 @@ "type": "long" }, { - "description": "Remaining capacity in terms of no. of more VMs that can be deployped with this vGPU type", - "name": "remainingcapacity", + "description": "Maximum vgpu can be created with this vgpu type on the given gpu group", + "name": "maxcapacity", "type": "long" } ], @@ -167070,262 +168387,347 @@ "type": "list" }, { - "description": "The name of extension for this cluster", - "name": "extensionname", + "description": "the amount of the host's memory currently allocated", + "name": "memoryallocated", + "type": "long" + }, + { + "description": "Used GPUs on the Host", + "name": "gpuused", + "type": "long" + }, + { + "description": "CPU Arch of the host", + "name": "arch", "type": "string" }, { - "description": "the amount of the host's CPU after applying the cpu.overprovisioning.factor", - "name": "cpuwithoverprovisioning", + "description": "the Pod ID of the host", + "name": "podid", "type": "string" }, { - "description": "comma-separated list of storage access groups on the pod", - "name": "podstorageaccessgroups", + "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 cluster name of the host", + "name": "clustername", "type": "string" }, { - "description": "The ID of extension for this cluster", - "name": "extensionid", + "description": "the host type", + "name": "type", + "type": "type" + }, + { + "description": "comma-separated list of implicit host tags for the host", + "name": "implicithosttags", "type": "string" }, { - "description": "the management server ID of the host", - "name": "managementserverid", + "description": "the amount of the host's memory currently used", + "name": "memoryused", + "type": "long" + }, + {}, + { + "description": "the last annotation set on this host by an admin", + "name": "annotation", "type": "string" }, { - "description": "true if the host has capability to support UEFI boot", - "name": "ueficapability", + "description": "Total GPUs on the Host", + "name": "gputotal", + "type": "long" + }, + { + "description": "the OS category name of the host", + "name": "oscategoryname", + "type": "string" + }, + { + "description": "The name of extension for this cluster", + "name": "extensionname", + "type": "string" + }, + { + "description": "the host hypervisor", + "name": "hypervisor", + "type": "string" + }, + { + "description": "the management server name of the host", + "name": "managementservername", + "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "true if local storage is active, false otherwise", + "name": "islocalstorageactive", "type": "boolean" }, { - "description": "the resource state of the host", - "name": "resourcestate", + "description": "true if the host supports instance conversion (using virt-v2v)", + "name": "instanceconversionsupported", + "type": "boolean" + }, + { + "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 hypervisor version", + "name": "hypervisorversion", "type": "string" }, + { + "description": "true if the host is disconnected. False otherwise.", + "name": "disconnected", + "type": "date" + }, + { + "description": "the incoming network traffic on the host", + "name": "networkkbsread", + "type": "long" + }, { "description": "the cluster type of the cluster that host belongs to", "name": "clustertype", "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 date and time the host was last pinged", + "name": "lastpinged", + "type": "date" }, { - "description": "the Zone name of the host", - "name": "zonename", + "description": "the Zone ID of the host", + "name": "zoneid", "type": "string" }, { - "description": "the CPU number of the host", - "name": "cpunumber", - "type": "integer" + "description": "the host's currently allocated disk size", + "name": "disksizeallocated", + "type": "long" }, { - "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 admin that annotated this host", - "name": "username", + "description": "the amount of the host's memory currently allocated in percentage", + "name": "memoryallocatedpercentage", "type": "string" }, { - "description": "the Pod name of the host", - "name": "podname", + "description": "the amount of the host's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "Host details in key/value pairs.", - "name": "details", - "type": "map" + "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 used", - "name": "memoryused", + "description": "the management server ID of the host", + "name": "managementserverid", + "type": "string" + } + ] + }, + { + "description": "Starts a stopped CloudManaged Kubernetes cluster", + "isasync": true, + "name": "startKubernetesCluster", + "params": [ + { + "description": "the ID of the Kubernetes cluster", + "length": 255, + "name": "id", + "related": "startKubernetesCluster", + "required": true, + "type": "uuid" + } + ], + "related": "", + "response": [ + { + "description": "Minimum size of the cluster", + "name": "minsize", "type": "long" }, { - "description": "the amount of the host's memory currently allocated in percentage", - "name": "memoryallocatedpercentage", + "description": "the ID of the network of the Kubernetes cluster", + "name": "networkid", "type": "string" }, { - "description": "true if local storage is active, false otherwise", - "name": "islocalstorageactive", - "type": "boolean" + "description": "URL end point for the Kubernetes cluster", + "name": "endpoint", + "type": "string" }, { - "description": "the incoming network traffic on the host", - "name": "networkkbsread", - "type": "long" + "description": "Indicates if the CloudStack CSI driver has been setup in the cluster", + "name": "csienabled", + "type": "boolean" }, { - "description": "the name of the host", - "name": "name", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zoneid", "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 control nodes on the Kubernetes cluster", + "name": "controlofferingid", + "type": "string" }, { - "description": "the cpu average load on the host", - "name": "cpuloadaverage", - "type": "double" + "description": "the memory the Kubernetes cluster", + "name": "memory", + "type": "string" }, { - "description": "true if the host supports instance conversion (using virt-v2v)", - "name": "instanceconversionsupported", - "type": "boolean" + "description": "the name of the domain in which the Kubernetes cluster exists", + "name": "domain", + "type": "string" }, { - "description": "Used GPUs on the Host", - "name": "gpuused", - "type": "long" + "description": "the project name of the Kubernetes cluster", + "name": "project", + "type": "string" }, { - "description": "true if the host is disconnected. False otherwise.", - "name": "disconnected", - "type": "date" + "description": "the name of the Kubernetes cluster", + "name": "name", + "type": "string" }, { - "description": "the state of the host", - "name": "state", - "type": "status" + "description": "the description of the Kubernetes cluster", + "name": "description", + "type": "string" }, { - "description": "the date and time the host was created", - "name": "created", - "type": "date" + "description": "Name of CNI Configuration associated with the cluster", + "name": "cniconfigname", + "type": "string" }, { - "description": "the Zone ID of the host", - "name": "zoneid", + "description": "the name of the network of the Kubernetes cluster", + "name": "associatednetworkname", "type": "string" }, { - "description": "events available for the host", - "name": "events", + "description": "the ID of the service offering of the worker nodes on the Kubernetes cluster", + "name": "workerofferingid", "type": "string" }, { - "description": "the management server name of the host", - "name": "managementservername", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the outgoing network traffic on the host", - "name": "networkkbswrite", - "type": "long" + "description": "the ID of the service offering of the Kubernetes cluster", + "name": "serviceofferingid", + "type": "string" }, - {}, { - "description": "the date and time the host was removed", - "name": "removed", - "type": "date" + "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": "Whether autoscaling is enabled for the cluster", + "name": "autoscalingenabled", + "type": "boolean" }, { - "description": "the host HA information information", - "name": "hostha", - "type": "hostharesponse" + "description": "the name of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionname", + "type": "string" }, { - "description": "comma-separated list of storage access groups on the cluster", - "name": "clusterstorageaccessgroups", + "description": "ID of CNI Configuration associated with the cluster", + "name": "cniconfigurationid", "type": "string" }, { - "description": "comma-separated list of tags for the host", - "name": "hosttags", + "description": "Public IP Address ID of the cluster", + "name": "ipaddressid", "type": "string" }, { - "description": "the amount of the host's CPU currently allocated in percentage", - "name": "cpuallocatedpercentage", + "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingname", "type": "string" }, { - "description": "the amount of the host's CPU currently used", - "name": "cpuused", - "type": "string" + "description": "Public IP Addresses of the etcd nodes", + "name": "etcdips", + "type": "map" }, { - "description": "the host's currently allocated disk size", - "name": "disksizeallocated", + "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", + "name": "masternodes", "type": "long" }, { - "description": "the cluster name of the host", - "name": "clustername", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "capabilities of the host", - "name": "capabilities", - "type": "string" + "description": "the size (worker nodes count) of the Kubernetes cluster", + "name": "size", + "type": "long" }, { - "description": "the amount of the host's CPU currently allocated after applying the cpu.overprovisioning.factor", - "name": "cpuallocatedwithoverprovisioning", - "type": "string" + "description": "the date when this Kubernetes cluster was created", + "name": "created", + "type": "date" }, { - "description": "the hypervisor version", - "name": "hypervisorversion", + "description": "the name of the template of the Kubernetes cluster", + "name": "templatename", "type": "string" }, { - "description": "the last time this host was annotated", - "name": "lastannotated", - "type": "date" - }, - { - "description": "the amount of the host's memory currently allocated in bytes", - "name": "memoryallocatedbytes", + "description": "the number of the etcd nodes on the Kubernetes cluster", + "name": "etcdnodes", "type": "long" }, { - "description": "Total GPUs on the Host", - "name": "gputotal", - "type": "long" + "description": "the ID of the Kubernetes version for the Kubernetes cluster", + "name": "kubernetesversionid", + "type": "string" }, { - "description": "the host out-of-band management information", - "name": "outofbandmanagement", - "type": "outofbandmanagementresponse" - } - ] - }, - { - "description": "Starts a stopped CloudManaged Kubernetes cluster", - "isasync": true, - "name": "startKubernetesCluster", - "params": [ + "description": "URL end point for the Kubernetes cluster dashboard UI", + "name": "consoleendpoint", + "type": "string" + }, { - "description": "the ID of the Kubernetes cluster", - "length": 255, - "name": "id", - "related": "startKubernetesCluster", - "required": true, - "type": "uuid" - } - ], - "related": "", - "response": [ + "description": "keypair details", + "name": "keypair", + "type": "string" + }, { - "description": "the ID of the service offering of the Kubernetes cluster", - "name": "serviceofferingid", + "description": "the ID of the domain in which the Kubernetes cluster exists", + "name": "domainid", "type": "string" }, { @@ -167334,9 +168736,9 @@ "type": "list" }, { - "description": "Minimum size of the cluster", - "name": "minsize", - "type": "long" + "description": "the type of the cluster", + "name": "clustertype", + "type": "clustertype" }, { "description": "the project id of the Kubernetes cluster", @@ -167344,75 +168746,55 @@ "type": "string" }, { - "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingid", - "type": "string" - }, - { - "description": "the state of the Kubernetes cluster", - "name": "state", - "type": "string" - }, - { - "description": "the id of the Kubernetes cluster", - "name": "id", + "description": "the cpu cores of the Kubernetes cluster", + "name": "cpunumber", "type": "string" }, {}, { - "description": "the memory the Kubernetes cluster", - "name": "memory", - "type": "string" - }, - { - "description": "the account associated with the Kubernetes cluster", - "name": "account", + "description": "the name of the service offering of the Kubernetes cluster", + "name": "serviceofferingname", "type": "string" }, { - "description": "ID of CNI Configuration associated with the cluster", - "name": "cniconfigurationid", + "description": "the name of the zone of the Kubernetes cluster", + "name": "zonename", "type": "string" }, { - "description": "Whether autoscaling is enabled for the cluster", - "name": "autoscalingenabled", - "type": "boolean" - }, - { - "description": "the project name of the Kubernetes cluster", - "name": "project", + "description": "the state of the Kubernetes cluster", + "name": "state", "type": "string" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "Maximum size of the cluster", + "name": "maxsize", + "type": "long" }, { - "description": "the name of the zone of the Kubernetes cluster", - "name": "zonename", + "description": "the ID of the template of the Kubernetes cluster", + "name": "templateid", "type": "string" }, { - "description": "the ID of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionid", + "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", + "description": "the ID of the service offering of the etcd nodes on the Kubernetes cluster", + "name": "etcdofferingid", "type": "string" }, { - "description": "URL end point for the Kubernetes cluster dashboard UI", - "name": "consoleendpoint", + "description": "Public IP Address of the cluster", + "name": "ipaddress", "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" }, { @@ -167421,133 +168803,184 @@ "type": "long" }, { - "description": "the name of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingname", + "description": "the account associated with the Kubernetes cluster", + "name": "account", "type": "string" }, { - "description": "the name of the service offering of the etcd nodes on the Kubernetes cluster", - "name": "etcdofferingname", + "description": "the id of the Kubernetes cluster", + "name": "id", "type": "string" }, { - "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": "Upload a supported Kubernetes version", + "isasync": false, + "name": "getUploadParamsForKubernetesSupportedVersion", + "params": [ + { + "description": "the minimum number of CPUs to be set with the Kubernetes version", + "length": 255, + "name": "mincpunumber", + "required": true, + "type": "integer" }, { - "description": "URL end point for the Kubernetes cluster", - "name": "endpoint", + "description": "the format for the volume/template/iso. Possible values include QCOW2, OVA, and VHD.", + "length": 255, + "name": "format", + "required": true, "type": "string" }, { - "description": "the name of the service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingname", - "type": "string" + "description": "Upload volume/template/iso for the project", + "length": 255, + "name": "projectid", + "related": "", + "required": false, + "type": "uuid" }, { - "description": "Name of CNI Configuration associated with the cluster", - "name": "cniconfigname", + "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": "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": "the name of the Kubernetes cluster", - "name": "name", + "description": "the semantic version of the Kubernetes version. It needs to be specified in MAJOR.MINOR.PATCH format", + "length": 255, + "name": "semanticversion", + "required": true, "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "the minimum RAM size in MB to be set with the Kubernetes version", + "length": 255, + "name": "minmemory", + "required": true, + "type": "integer" }, { - "description": "Public IP Address of the cluster", - "name": "ipaddress", + "description": "an optional accountName. Must be used with domainId.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the cpu cores of the Kubernetes cluster", - "name": "cpunumber", - "type": "string" + "description": "the ID of the zone the volume/template/iso is to be hosted on", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, + "type": "uuid" }, { - "description": "Public IP Address ID of the cluster", - "name": "ipaddressid", + "description": "the checksum value of the binaries 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": "Maximum size of the cluster", - "name": "maxsize", - "type": "long" + "description": "the name of the volume/template/iso", + "length": 255, + "name": "name", + "required": true, + "type": "string" + } + ], + "related": "", + "response": [ + { + "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 service offering of the worker nodes on the Kubernetes cluster", - "name": "workerofferingid", + "description": "the id of the zone in which Kubernetes supported version is available", + "name": "zoneid", "type": "string" }, { - "description": "the ID of the service offering of the control nodes on the Kubernetes cluster", - "name": "controlofferingid", + "description": "the id of the Kubernetes supported version", + "name": "id", "type": "string" }, { - "description": "the type of the cluster", - "name": "clustertype", - "type": "clustertype" + "description": "the minimum number of CPUs needed for the Kubernetes supported version", + "name": "mincpunumber", + "type": "integer" }, { - "description": "the master nodes count for the Kubernetes cluster. This parameter is deprecated, please use 'controlnodes' parameter.", - "name": "masternodes", - "type": "long" + "description": "the date when this Kubernetes supported version was created", + "name": "created", + "type": "date" }, { - "description": "the number of the etcd nodes on the Kubernetes cluster", - "name": "etcdnodes", - "type": "long" + "description": "the enabled or disabled state of the Kubernetes supported version", + "name": "state", + "type": "string" }, { - "description": "the size (worker nodes count) of the Kubernetes cluster", - "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 zone of the Kubernetes cluster", - "name": "zoneid", + "description": "Name of the Kubernetes supported version", + "name": "name", "type": "string" }, { - "description": "the name of the service offering of the Kubernetes cluster", - "name": "serviceofferingname", + "description": "the id of the binaries ISO for Kubernetes supported version", + "name": "isoid", "type": "string" }, + {}, { - "description": "path of the domain to which the Kubernetes cluster belongs", - "name": "domainpath", + "description": "the state of the binaries ISO for Kubernetes supported version", + "name": "isostate", "type": "string" }, { - "description": "the description of the Kubernetes cluster", - "name": "description", + "description": "the name of the zone in which Kubernetes supported version is available", + "name": "zonename", "type": "string" }, { - "description": "Public IP Addresses of the etcd nodes", - "name": "etcdips", - "type": "map" + "description": "the name of the binaries ISO for Kubernetes supported version", + "name": "isoname", + "type": "string" }, { - "description": "the name of the Kubernetes version for the Kubernetes cluster", - "name": "kubernetesversionname", - "type": "string" + "description": "whether Kubernetes supported version supports HA, multi-control nodes", + "name": "supportsha", + "type": "boolean" }, { - "description": "the ID of the template of the Kubernetes cluster", - "name": "templateid", + "description": "Kubernetes semantic version", + "name": "semanticversion", "type": "string" }, { - "description": "the name of the domain in which the Kubernetes cluster exists", - "name": "domain", + "description": "the arch of the binaries ISO for Kubernetes supported version", + "name": "arch", "type": "string" }, { @@ -167556,14 +168989,15 @@ "type": "string" }, { - "description": "keypair details", - "name": "keypair", - "type": "string" + "description": "whether Kubernetes supported version supports Autoscaling", + "name": "supportsautoscaling", + "type": "boolean" }, + {}, { - "description": "the ID of the domain in which the Kubernetes cluster exists", - "name": "domainid", - "type": "string" + "description": "the minimum RAM size in MB needed for the Kubernetes supported version", + "name": "minmemory", + "type": "integer" } ] }, @@ -167590,28 +169024,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": "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": "3.0.0" }, @@ -167630,37 +169064,37 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "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 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" }, - {} + { + "description": "the name of the shared filesystem provider", + "name": "name", + "type": "string" + } ], "since": "4.20.0" }, @@ -167680,43 +169114,43 @@ ], "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", - "type": "boolean" - }, - { - "description": "the template ID", - "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 current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" - }, { "description": "the ID of the domain to which the template belongs", "name": "domainid", "type": "string" }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", + "type": "boolean" + }, + { + "description": "the list of projects the template is available for", + "name": "projectids", + "type": "list" + }, { "description": "the list of accounts the template is available for", "name": "account", "type": "list" }, - {} + {}, + { + "description": "the template ID", + "name": "id", + "type": "string" + } ] }, { @@ -167724,6 +169158,20 @@ "isasync": true, "name": "addNetscalerLoadBalancer", "params": [ + { + "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": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", + "length": 255, + "name": "networkdevicetype", + "required": true, + "type": "string" + }, { "description": "the Physical Network ID", "length": 255, @@ -167746,20 +169194,6 @@ "required": true, "type": "string" }, - { - "description": "private IP of the site", - "length": 255, - "name": "gslbproviderprivateip", - "required": false, - "type": "string" - }, - { - "description": "Netscaler device type supports NetscalerMPXLoadBalancer, NetscalerVPXLoadBalancer, NetscalerSDXLoadBalancer", - "length": 255, - "name": "networkdevicetype", - "required": true, - "type": "string" - }, { "description": "Credentials to reach netscaler load balancer device", "length": 255, @@ -167774,26 +169208,26 @@ "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" + }, + { + "description": "private IP of the site", + "length": 255, + "name": "gslbproviderprivateip", + "required": false, + "type": "string" } ], "related": "", "response": [ { - "description": "device name", - "name": "lbdevicename", + "description": "the public interface of the load balancer", + "name": "publicinterface", "type": "string" }, { @@ -167807,39 +169241,24 @@ "type": "string" }, { - "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": "name of the provider", + "name": "provider", + "type": "string" }, { - "description": "device state", - "name": "lbdevicestate", - "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" }, - { - "description": "the private interface of the load balancer", - "name": "privateinterface", - "type": "string" - }, {}, { - "description": "the public interface of the load balancer", - "name": "publicinterface", - "type": "string" - }, - { - "description": "private IP of the NetScaler representing GSLB site", - "name": "gslbproviderprivateip", + "description": "public IP of the NetScaler representing GSLB site", + "name": "gslbproviderpublicip", "type": "string" }, { @@ -167848,23 +169267,39 @@ "type": "long" }, { - "description": "public IP of the NetScaler representing GSLB site", - "name": "gslbproviderpublicip", + "description": "true if device is dedicated for an account", + "name": "lbdevicededicated", + "type": "boolean" + }, + {}, + { + "description": "true if NetScaler device is provisioned to be a GSLB service provider", + "name": "gslbprovider", + "type": "boolean" + }, + { + "description": "device state", + "name": "lbdevicestate", "type": "string" }, { - "description": "true if device is dedicated for an account", - "name": "lbdevicededicated", + "description": "the private interface of the load balancer", + "name": "privateinterface", + "type": "string" + }, + { + "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": "the physical network to which this netscaler device belongs to", + "name": "physicalnetworkid", + "type": "string" }, { - "description": "name of the provider", - "name": "provider", + "description": "device name", + "name": "lbdevicename", "type": "string" }, { @@ -167872,10 +169307,9 @@ "name": "podids", "type": "list" }, - {}, { - "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" } ] @@ -167885,25 +169319,87 @@ "isasync": false, "name": "listBackupSchedule", "params": [ + { + "description": "list only resources belonging to the domain specified", + "length": 255, + "name": "domainid", + "related": "listDomains", + "required": false, + "type": "uuid" + }, + { + "description": "list objects by project; if projectid=-1 lists All VMs", + "length": 255, + "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.", + "length": 255, + "name": "listall", + "required": false, + "type": "boolean" + }, { "description": "ID of the VM", "length": 255, "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": true, + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", + "required": false, "type": "uuid" - } - ], - "related": "", - "response": [ + }, { - "description": "ID of the backup schedule.", + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "the ID of the backup schedule", + "length": 255, "name": "id", + "related": "listBackupSchedule", + "required": false, + "since": "4.22.0", + "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 account. Must be used with the domainId parameter.", + "length": 255, + "name": "account", + "required": false, "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + } + ], + "related": "", + "response": [ + { + "description": "ID of the VM", + "name": "virtualmachineid", "type": "string" }, { @@ -167911,36 +169407,41 @@ "name": "maxbackups", "type": "integer" }, + {}, { - "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 UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" }, - {}, { "description": "time the backup is scheduled to be taken.", "name": "schedule", "type": "string" }, { - "description": "name of the VM", - "name": "virtualmachinename", + "description": "ID of the backup schedule.", + "name": "id", "type": "string" }, {}, - { - "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", - "name": "virtualmachineid", + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + { + "description": "name of the VM", + "name": "virtualmachinename", "type": "string" }, { @@ -167975,33 +169476,33 @@ "description": "id of the VM where to attach the restored volume", "length": 255, "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", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,importVm", "required": true, "type": "uuid" } ], "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": "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.14.0" @@ -168045,13 +169546,13 @@ ], "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": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -168059,12 +169560,12 @@ "name": "success", "type": "boolean" }, - {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", "type": "integer" }, + {}, {} ], "since": "4.17.0" @@ -168075,18 +169576,18 @@ "name": "configTungstenFabricService", "params": [ { - "description": "the ID of zone", + "description": "the ID of physical network", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "physicalnetworkid", + "related": "", "required": true, "type": "uuid" }, { - "description": "the ID of physical network", + "description": "the ID of zone", "length": 255, - "name": "physicalnetworkid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": true, "type": "uuid" } @@ -168097,18 +169598,18 @@ "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" }, + {}, + {}, { "description": "the current status of the latest async job acting on this object", "name": "jobstatus", @@ -168128,14 +169629,6 @@ "required": false, "type": "string" }, - { - "description": "the Physical Network ID", - "length": 255, - "name": "physicalnetworkid", - "related": "", - "required": true, - "type": "uuid" - }, { "description": "Pxe server device ID", "length": 255, @@ -168146,47 +169639,55 @@ { "description": "", "length": 255, - "name": "pagesize", + "name": "page", "required": false, "type": "integer" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" + }, + { + "description": "the Physical Network ID", + "length": 255, + "name": "physicalnetworkid", + "related": "", + "required": true, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the physical network to which this external dhcp device belongs to", - "name": "physicalnetworkid", + "description": "name of the provider", + "name": "provider", + "type": "string" + }, + { + "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": "url", - "name": "url", - "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": "name of the provider", - "name": "provider", + "description": "url", + "name": "url", "type": "string" }, - {}, - {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", @@ -168210,39 +169711,33 @@ "related": "", "response": [ { - "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 source type of the user in lowercase, such as native, ldap, saml2", - "name": "usersource", + "description": "the domain name of the user", + "name": "domain", "type": "string" }, { - "description": "the api key of the user", - "name": "apikey", + "description": "the user state", + "name": "state", "type": "string" }, { - "description": "the date and time the user account was created", - "name": "created", - "type": "date" - }, - { - "description": "the ID of the role", - "name": "roleid", + "description": "the timezone user was created in", + "name": "timezone", "type": "string" }, - {}, { - "description": "the user name", - "name": "username", + "description": "the user email address", + "name": "email", "type": "string" }, { - "description": "the account ID of the user", - "name": "accountid", + "description": "the user ID", + "name": "id", "type": "string" }, { @@ -168251,74 +169746,84 @@ "type": "string" }, { - "description": "the user lastname", - "name": "lastname", - "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 account type of the user", + "name": "accounttype", + "type": "integer" }, { - "description": "the secret key of the user", - "name": "secretkey", + "description": "true if user has two factor authentication is mandated", + "name": "is2famandated", + "type": "boolean" + }, + { + "description": "the date and time the user account was created", + "name": "created", + "type": "date" + }, + { + "description": "the user firstname", + "name": "firstname", "type": "string" }, { - "description": "the user ID", - "name": "id", + "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 secret key of the user", + "name": "secretkey", + "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 name of the role", + "name": "rolename", + "type": "string" }, - {}, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", - "type": "integer" + "description": "the type of the role", + "name": "roletype", + "type": "string" }, { - "description": "the account type of the user", - "name": "accounttype", - "type": "integer" + "description": "true if user is default, false otherwise", + "name": "isdefault", + "type": "boolean" }, { - "description": "the user firstname", - "name": "firstname", + "description": "the ID of the role", + "name": "roleid", "type": "string" }, { - "description": "the timezone user was created in", - "name": "timezone", + "description": "the account ID of the user", + "name": "accountid", "type": "string" }, { - "description": "true if user has two factor authentication is mandated", - "name": "is2famandated", + "description": "true if user has two factor authentication enabled", + "name": "is2faenabled", "type": "boolean" }, { - "description": "the name of the role", - "name": "rolename", + "description": "the user name", + "name": "username", "type": "string" }, { - "description": "the account name of the user", - "name": "account", + "description": "the api key of the user", + "name": "apikey", "type": "string" }, { - "description": "the domain name of the user", - "name": "domain", + "description": "the source type of the user in lowercase, such as native, ldap, saml2", + "name": "usersource", "type": "string" }, { @@ -168327,25 +169832,21 @@ "type": "string" }, { - "description": "the user state", - "name": "state", - "type": "string" - }, - { - "description": "the user email address", - "name": "email", + "description": "the user lastname", + "name": "lastname", "type": "string" }, { - "description": "true if user has two factor authentication enabled", - "name": "is2faenabled", - "type": "boolean" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "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" + }, + {} ] }, { @@ -168354,12 +169855,11 @@ "name": "listLoadBalancerRules", "params": [ { - "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": "List resources by tags (key/value pairs)", @@ -168369,28 +169869,20 @@ "type": "map" }, { - "description": "list objects by project; if projectid=-1 lists All VMs", + "description": "the name of the load balancer rule", "length": 255, - "name": "projectid", - "related": "", + "name": "name", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "list by network ID the rule belongs to", + "description": "the availability zone ID", "length": 255, - "name": "networkid", - "related": "createNetwork,updateNetwork,listNetworks", + "name": "zoneid", + "related": "listZones", "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": "the public IP address ID of the load balancer rule", "length": 255, @@ -168399,13 +169891,6 @@ "required": false, "type": "uuid" }, - { - "description": "list resources by account. Must be used with the domainId parameter.", - "length": 255, - "name": "account", - "required": false, - "type": "string" - }, { "description": "List by keyword", "length": 255, @@ -168414,25 +169899,25 @@ "type": "string" }, { - "description": "the name of the load balancer rule", + "description": "", "length": 255, - "name": "name", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "the ID of the virtual machine of the load balancer rule", + "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": "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", + "name": "listall", "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.", + "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" }, { @@ -168444,24 +169929,25 @@ "type": "uuid" }, { - "description": "the availability zone ID", + "description": "list by network ID the rule belongs to", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "networkid", + "related": "createNetwork,updateNetwork,listNetworks", "required": false, "type": "uuid" }, { - "description": "", + "description": "the ID of the virtual machine of the load balancer rule", "length": 255, - "name": "page", + "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,createVMFromBackup,importVm", "required": false, - "type": "integer" + "type": "uuid" }, { - "description": "the ID of the load balancer rule", + "description": "list objects by project; if projectid=-1 lists All VMs", "length": 255, - "name": "id", + "name": "projectid", "related": "", "required": false, "type": "uuid" @@ -168472,187 +169958,202 @@ "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" + }, + { + "description": "the ID of the load balancer rule", + "length": 255, + "name": "id", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "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 list of resource tags associated with load balancer", + "name": "tags", + "response": [ + { + "description": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "tag value", + "name": "value", + "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": "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 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": "the project id the tag belongs to", + "name": "projectid", + "type": "string" + } + ], + "type": "list" }, { - "description": "path of the domain to which the load balancer rule belongs", - "name": "domainpath", + "description": "the load balancer rule ID", + "name": "id", "type": "string" }, { - "description": "the protocol of the loadbalanacer rule", - "name": "protocol", + "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 name of the load balancer", - "name": "name", + "description": "the id of the zone the rule belongs to", + "name": "zoneid", "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" }, { - "description": "the load balancer algorithm (source, roundrobin, leastconn)", - "name": "algorithm", + "description": "the account of the load balancer rule", + "name": "account", "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 project id of the load balancer", - "name": "projectid", + "description": "the public port", + "name": "publicport", "type": "string" }, { - "description": "the public ip address", - "name": "publicip", + "description": "the private port", + "name": "privateport", "type": "string" }, + {}, { - "description": "the account of the load balancer rule", - "name": "account", + "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" }, { - "description": "the project name of the load balancer", - "name": "project", - "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 load balancer rule belongs to", - "name": "zonename", + "description": "the domain ID of the load balancer rule", + "name": "domainid", "type": "string" }, { - "description": "the domain of the load balancer rule", - "name": "domain", + "description": "the description of the load balancer", + "name": "description", "type": "string" }, { - "description": "the description of the load balancer", - "name": "description", + "description": "the project name of the load balancer", + "name": "project", "type": "string" }, - {}, { - "description": "the id of the guest network the lb rule belongs to", - "name": "networkid", + "description": "the name of the load balancer", + "name": "name", "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 zone the rule belongs to", - "name": "zoneid", + "description": "the domain of the load balancer rule", + "name": "domain", "type": "string" }, { - "description": "the public port", - "name": "publicport", + "description": "the public ip address", + "name": "publicip", "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" }, { - "description": "the private port", - "name": "privateport", + "description": "the public ip address id", + "name": "publicipid", "type": "string" }, - {}, { - "description": "the list of resource tags associated with load balancer", - "name": "tags", - "response": [ - { - "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": "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" - }, - { - "description": "tag value", - "name": "value", - "type": "string" - }, - { - "description": "tag key name", - "name": "key", - "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", - "type": "string" - } - ], - "type": "list" + "description": "path of the domain to which the load balancer rule belongs", + "name": "domainpath", + "type": "string" }, { - "description": "the public ip address id", - "name": "publicipid", + "description": "the project id of the load balancer", + "name": "projectid", "type": "string" }, { - "description": "the state of the rule", - "name": "state", + "description": "the protocol of the loadbalanacer rule", + "name": "protocol", "type": "string" } ] @@ -168663,31 +170164,32 @@ "name": "createManagementNetworkIpRange", "params": [ { - "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 netmask for the management network.", "length": 255, - "name": "vlan", - "required": false, + "name": "netmask", + "required": true, "type": "string" }, { - "description": "The gateway for the management network.", + "description": "UUID of POD, where the IP range belongs to.", "length": 255, - "name": "gateway", + "name": "podid", + "related": "createManagementNetworkIpRange", "required": true, - "type": "string" + "type": "uuid" }, { - "description": "The netmask for the management network.", + "description": "The gateway for the management network.", "length": 255, - "name": "netmask", + "name": "gateway", "required": true, "type": "string" }, { - "description": "The starting IP address.", + "description": "The ending IP address.", "length": 255, - "name": "startip", - "required": true, + "name": "endip", + "required": false, "type": "string" }, { @@ -168698,87 +170200,77 @@ "type": "boolean" }, { - "description": "The ending IP address.", + "description": "The starting IP address.", "length": 255, - "name": "endip", - "required": false, + "name": "startip", + "required": true, "type": "string" }, { - "description": "UUID of POD, where the IP range belongs to.", + "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": "podid", - "related": "createManagementNetworkIpRange", - "required": true, - "type": "uuid" + "name": "vlan", + "required": false, + "type": "string" } ], "related": "", "response": [ - { - "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", - "name": "endip", - "type": "list" - }, - { - "description": "the netmask of the Pod", - "name": "netmask", - "type": "string" - }, - { - "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", - "name": "jobstatus", - "type": "integer" - }, { "description": "the Zone ID of the Pod", "name": "zoneid", "type": "string" }, - { - "description": "the allocation state of the Pod", - "name": "allocationstate", - "type": "string" - }, - {}, - { - "description": "the ID of the Pod", - "name": "id", - "type": "string" - }, { "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", + "description": "the IP ranges for the Pod", + "name": "ipranges", "response": [ { - "description": "the Cluster ID", - "name": "clusterid", + "description": "the gateway for the range", + "name": "gateway", "type": "string" }, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "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 ending IP for the range", + "name": "endip", + "type": "string" + }, + { + "description": "indicates Vlan ID for the range", + "name": "vlanid", + "type": "string" + }, + { + "description": "indicates if range is dedicated for CPVM and SSVM", + "name": "forsystemvms", + "type": "string" + } + ], + "type": "list" + }, + { + "description": "the capacity of the Pod", + "name": "capacity", + "response": [ + { + "description": "the Pod ID", + "name": "podid", + "type": "string" }, { "description": "the capacity currently in use", @@ -168786,39 +170278,44 @@ "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", - "type": "string" + "description": "the capacity type", + "name": "type", + "type": "short" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity name", + "name": "name", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the Pod ID", - "name": "podid", + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { - "description": "the capacity name", - "name": "name", + "description": "the total capacity available", + "name": "capacitytotal", + "type": "long" + }, + { + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the capacity type", - "name": "type", - "type": "short" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the capacity currently in allocated", @@ -168826,21 +170323,26 @@ "type": "long" }, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Cluster name", + "name": "clustername", + "type": "string" + }, + { + "description": "the Pod name", + "name": "podname", "type": "string" } ], "type": "list" }, { - "description": "comma-separated list of storage access groups for the pod", - "name": "storageaccessgroups", + "description": "comma-separated list of storage access groups on the zone", + "name": "zonestorageaccessgroups", "type": "string" }, { - "description": "the Zone name of the Pod", - "name": "zonename", + "description": "the name of the Pod", + "name": "name", "type": "string" }, { @@ -168849,62 +170351,61 @@ "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 allocation state of the Pod", + "name": "allocationstate", + "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "the IP ranges for the Pod", - "name": "ipranges", - "response": [ - { - "description": "the CIDR for the range", - "name": "cidr", - "type": "string" - }, - { - "description": "the gateway for the range", - "name": "gateway", - "type": "string" - }, - { - "description": "the starting IP for the range", - "name": "startip", - "type": "string" - }, - { - "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 name of the Pod", + "name": "zonename", + "type": "string" }, - {}, { - "description": "the name of the Pod", - "name": "name", + "description": "the ID of the Pod", + "name": "id", "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": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the ending IP for the Pod. This parameter is deprecated, please use 'endip' from ipranges parameter.", + "name": "endip", + "type": "list" + }, + { + "description": "comma-separated list of storage access groups for the pod", + "name": "storageaccessgroups", + "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 netmask of the Pod", + "name": "netmask", + "type": "string" } ], "since": "4.11.0.0" @@ -168915,18 +170416,19 @@ "name": "listCiscoNexusVSMs", "params": [ { - "description": "List by keyword", + "description": "", "length": 255, - "name": "keyword", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "", + "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "page", + "name": "clusterid", + "related": "", "required": false, - "type": "integer" + "type": "uuid" }, { "description": "", @@ -168938,37 +170440,42 @@ { "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", "length": 255, - "name": "clusterid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, "type": "uuid" }, { - "description": "Id of the CloudStack cluster in which the Cisco Nexus 1000v VSM appliance.", + "description": "List by keyword", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "keyword", "required": false, - "type": "uuid" + "type": "string" } ], "related": "", "response": [ { - "description": "storage vlan id of the VSM", - "name": "vsmstoragevlanid", - "type": "int" + "description": "The mode of the VSM (standalone/HA)", + "name": "vsmconfigmode", + "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": "packet vlan id of the VSM", - "name": "vsmpktvlanid", - "type": "int" + "description": "device name", + "name": "vsmdevicename", + "type": "string" }, + { + "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", + "name": "ipaddress", + "type": "string" + }, + {}, { "description": "The VSM is a switch supervisor. This is the VSM's switch domain id", "name": "vsmdomainid", @@ -168979,37 +170486,31 @@ "name": "vsmdevicestate", "type": "string" }, - {}, { - "description": "management vlan id of the VSM", - "name": "vsmmgmtvlanid", - "type": "string" + "description": "packet vlan id of the VSM", + "name": "vsmpktvlanid", + "type": "int" }, + {}, { - "description": "The Config State (Primary/Standby) of the VSM", - "name": "vsmconfigstate", - "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": "management vlan id of the VSM", + "name": "vsmmgmtvlanid", "type": "string" }, { - "description": "the management IP address of the external Cisco Nexus 1000v Virtual Supervisor Module", - "name": "ipaddress", + "description": "device id of the Cisco N1KV VSM device", + "name": "vsmdeviceid", "type": "string" }, { - "description": "control vlan id of the VSM", - "name": "vsmctrlvlanid", - "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", + "type": "string" }, { "description": "the UUID of the latest async job acting on this object", @@ -169017,14 +170518,14 @@ "type": "string" }, { - "description": "device name", - "name": "vsmdevicename", - "type": "string" + "description": "storage vlan id of the VSM", + "name": "vsmstoragevlanid", + "type": "int" }, { - "description": "The Device State (Enabled/Disabled) of the VSM", - "name": "vsmdevicestate", - "type": "string" + "description": "control vlan id of the VSM", + "name": "vsmctrlvlanid", + "type": "int" } ] }, @@ -169033,13 +170534,6 @@ "isasync": true, "name": "addVpnUser", "params": [ - { - "description": "username for the vpn user", - "length": 255, - "name": "username", - "required": true, - "type": "string" - }, { "description": "password for the username", "length": 255, @@ -169055,6 +170549,13 @@ "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" + }, { "description": "an optional domainId for the vpn user. If the account parameter is used, domainId must also be used.", "length": 255, @@ -169064,18 +170565,20 @@ "type": "uuid" }, { - "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" } ], "related": "", "response": [ + {}, + {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the domain id of the account of the remote access vpn", + "name": "domainid", "type": "string" }, { @@ -169083,10 +170586,9 @@ "name": "account", "type": "string" }, - {}, { - "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" }, { @@ -169094,25 +170596,14 @@ "name": "projectid", "type": "string" }, - {}, - { - "description": "the vpn userID", - "name": "id", - "type": "string" - }, { "description": "the username of the vpn user", "name": "username", "type": "string" }, { - "description": "the domain name of the account of the remote access vpn", - "name": "domain", - "type": "string" - }, - { - "description": "the project name of the vpn", - "name": "project", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -169121,14 +170612,24 @@ "type": "integer" }, { - "description": "path of the domain to which the remote access vpn belongs", - "name": "domainpath", + "description": "the domain name of the account of the remote access vpn", + "name": "domain", + "type": "string" + }, + { + "description": "the vpn userID", + "name": "id", "type": "string" }, { "description": "the state of the Vpn User, can be 'Add', 'Revoke' or 'Active'.", "name": "state", "type": "string" + }, + { + "description": "the project name of the vpn", + "name": "project", + "type": "string" } ] }, @@ -169155,17 +170656,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", @@ -169173,10 +170673,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" + }, + {} ], "since": "4.14.0" }, @@ -169204,13 +170705,18 @@ ], "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" }, {}, @@ -169219,11 +170725,6 @@ "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.15.0" @@ -169233,14 +170734,6 @@ "isasync": false, "name": "updateQuarantinedIp", "params": [ - { - "description": "The ID of the public IP address in active quarantine.", - "length": 255, - "name": "id", - "related": "updateQuarantinedIp", - "required": false, - "type": "uuid" - }, { "description": "The date when the quarantine will no longer be active.", "length": 255, @@ -169254,13 +170747,21 @@ "name": "ipaddress", "required": false, "type": "string" + }, + { + "description": "The ID of the public IP address in active quarantine.", + "length": 255, + "name": "id", + "related": "updateQuarantinedIp", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "Account name of the previous public IP address owner.", - "name": "previousownername", + "description": "The reason for removing the IP from quarantine prematurely.", + "name": "removalreason", "type": "string" }, { @@ -169268,30 +170769,25 @@ "name": "removeraccountid", "type": "string" }, - { - "description": "Account ID of the previous public IP address owner.", - "name": "previousownerid", - "type": "string" - }, + {}, { "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", + "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": "When the quarantine was created.", + "name": "created", + "type": "date" }, { - "description": "ID of the quarantine process.", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { @@ -169299,10 +170795,19 @@ "name": "enddate", "type": "date" }, - {}, { - "description": "The reason for removing the IP from quarantine prematurely.", - "name": "removalreason", + "description": "The public IP address in quarantine.", + "name": "ipaddress", + "type": "string" + }, + { + "description": "Account name of the previous public IP address owner.", + "name": "previousownername", + "type": "string" + }, + { + "description": "Account ID of the previous public IP address owner.", + "name": "previousownerid", "type": "string" }, { @@ -169310,11 +170815,7 @@ "name": "removed", "type": "date" }, - { - "description": "When the quarantine was created.", - "name": "created", - "type": "date" - } + {} ], "since": "4.19" }, @@ -169324,38 +170825,24 @@ "name": "updateVnfTemplate", "params": [ { - "description": "true if the template type is routing i.e., if template is used to deploy router", - "length": 255, - "name": "isrouting", - "required": false, - "type": "boolean" - }, - { - "description": "the display text of the image", - "length": 4096, - "name": "displaytext", - "required": false, - "type": "string" - }, - { - "description": "the tag for this template.", + "description": "the CPU arch of the template/ISO. Valid options are: x86_64, aarch64", "length": 255, - "name": "templatetag", + "name": "arch", "required": false, - "since": "4.20.0", + "since": "4.20", "type": "string" }, { - "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", + "description": "true if the template supports the sshkey upload feature; default is false", "length": 255, - "name": "isdynamicallyscalable", + "name": "sshkeyenabled", "required": false, "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" }, @@ -169367,62 +170854,39 @@ "type": "map" }, { - "description": "the ID of the image file", - "length": 255, - "name": "id", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate", - "required": true, - "type": "uuid" - }, - { - "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", + "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", "length": 255, - "name": "cleanupvnfdetails", + "name": "requireshvm", "required": false, "type": "boolean" }, { - "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", - "length": 255, - "name": "cleanupvnfnics", + "description": "the display text of the image", + "length": 4096, + "name": "displaytext", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "true if image is bootable, false otherwise; available only for updateIso API", + "description": "true if the template type is routing i.e., if template is used to deploy router", "length": 255, - "name": "bootable", + "name": "isrouting", "required": false, "type": "boolean" }, { - "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": "vnfdetails", - "required": false, - "type": "map" - }, - { - "description": "indicates that the template can be used for deployment of CKS clusters", + "description": "optional boolean field, which indicates if VNF nics will be cleaned up or not", "length": 255, - "name": "forcks", + "name": "cleanupvnfnics", "required": false, - "since": "4.21.0", "type": "boolean" }, { - "description": "the name of the image file", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, - { - "description": "sort key of the template, integer", + "description": "true if the image supports the password reset feature; default is false", "length": 255, - "name": "sortkey", + "name": "passwordenabled", "required": false, - "type": "integer" + "type": "boolean" }, { "description": "the ID of the OS type that best represents the OS of this image.", @@ -169433,32 +170897,33 @@ "type": "uuid" }, { - "description": "true if the template supports the sshkey upload feature; default is false", + "description": "sort key of the template, integer", "length": 255, - "name": "sshkeyenabled", + "name": "sortkey", "required": false, - "type": "boolean" + "type": "integer" }, { - "description": "true if the image supports the password reset feature; default is false", + "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": "passwordenabled", + "name": "cleanupdetails", "required": false, "type": "boolean" }, { - "description": "the format for the image", + "description": "the ID of the image file", "length": 255, - "name": "format", - "required": false, - "type": "string" + "name": "id", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "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": "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": "cleanupdetails", + "name": "vnfdetails", "required": false, - "type": "boolean" + "type": "map" }, { "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.", @@ -169469,140 +170934,75 @@ "type": "boolean" }, { - "description": "true if the template requires HVM, false otherwise; available only for updateTemplate API", + "description": "true if template/ISO contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory", "length": 255, - "name": "requireshvm", + "name": "isdynamicallyscalable", "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", + "description": "optional boolean field, which indicates if VNF details will be cleaned up or not", "length": 255, - "name": "vnfnics", + "name": "cleanupvnfdetails", "required": false, - "type": "map" - } - ], - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", - "response": [ - { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "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 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" }, { - "description": "true if the ISO is bootable, false otherwise", + "description": "true if image is bootable, false otherwise; available only for updateIso API", + "length": 255, "name": "bootable", + "required": false, "type": "boolean" }, { - "description": "CPU Arch of the template", - "name": "arch", - "type": "string" - }, - { - "description": "the template ID", - "name": "id", - "type": "string" - }, - { - "description": "path of the Domain the template belongs to", - "name": "domainpath", - "type": "string" - }, - { - "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": "true if this template is a featured template, false otherwise", - "name": "isfeatured", - "type": "boolean" - }, - { - "description": "true if the template is managed across all Zones, false otherwise", - "name": "crossZones", - "type": "boolean" - }, - { - "description": "the physical size of the template", - "name": "physicalsize", - "type": "long" - }, - { - "description": "VMware only: additional key/value details tied with deploy-as-is template", - "name": "deployasisdetails", + "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": "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", - "name": "userdatapolicy", + "description": "the format for the image", + "length": 255, + "name": "format", + "required": false, "type": "string" }, { - "description": "the account name to which the template belongs", - "name": "account", + "description": "the tag for this template.", + "length": 255, + "name": "templatetag", + "required": false, + "since": "4.20.0", "type": "string" }, { - "description": "the name of userdata linked to this template", - "name": "userdataname", + "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": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", - "name": "directdownload", + "description": "indicates that the template can be used for deployment of CKS clusters", + "length": 255, + "name": "forcks", + "required": false, + "since": "4.21.0", "type": "boolean" - }, - { - "description": "the size of the template", - "name": "size", - "type": "long" - }, + } + ], + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "response": [ { - "description": "the date this template was created", - "name": "created", - "type": "date" + "description": "the type of the template", + "name": "templatetype", + "type": "string" }, { - "description": "the format of the template.", - "name": "format", - "type": "imageformat" + "description": "the processor bit size", + "name": "bits", + "type": "int" }, { "description": "additional key/value details tied with template", @@ -169610,151 +171010,207 @@ "type": "map" }, { - "description": "the name of the domain to which the template belongs", - "name": "domain", + "description": "the template ID of the parent template if present", + "name": "sourcetemplateid", "type": "string" }, { - "description": "the URL which the template/iso is registered from", - "name": "url", - "type": "string" + "description": "true if the template is managed across all Zones, false otherwise", + "name": "crossZones", + "type": "boolean" }, { - "description": "Lists the download progress of a template across all secondary storages", - "name": "downloaddetails", - "type": "list" + "description": "the tag of this template", + "name": "templatetag", + "type": "string" }, { - "description": "true if template 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 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", + "description": "the size of the template", + "name": "size", + "type": "long" + }, + {}, + { + "description": "If true it indicates that the template can be used for CKS cluster deployments", + "name": "forcks", "type": "boolean" }, + { + "description": "the date this template was created", + "name": "created", + "type": "date" + }, + { + "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 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 key name", + "name": "key", "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": "resource type", - "name": "resourcetype", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "tag value", - "name": "value", + "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 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": "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": "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" } ], "type": "set" }, { - "description": "true if the template is ready to be deployed from, false otherwise.", - "name": "isready", + "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", + "type": "string" + }, + { + "description": "true if this template is a public template, false otherwise", + "name": "ispublic", "type": "boolean" }, { - "description": "If true it indicates that the template can be used for CKS cluster deployments", - "name": "forcks", + "description": "true if the ISO is bootable, false otherwise", + "name": "bootable", "type": "boolean" }, { - "description": "the ID of the zone for this template", - "name": "zoneid", + "description": "the project name of the template", + "name": "project", "type": "string" }, { - "description": "the ID of the domain to which the template belongs", - "name": "domainid", + "description": "the date this template was removed", + "name": "removed", + "type": "date" + }, + { + "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 name of the OS type for this template.", - "name": "ostypename", + "description": "path of the Domain the template belongs to", + "name": "domainpath", "type": "string" }, { - "description": "checksum of the template", - "name": "checksum", + "description": "The ID of extension linked to this template", + "name": "extensionid", "type": "string" }, { - "description": "Base64 string representation of the resource icon", - "name": "icon", - "type": "resourceiconresponse" + "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", + "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": "VMware only: additional key/value details tied with deploy-as-is template", + "name": "deployasisdetails", + "type": "map" + }, + { + "description": "the project id of the template", + "name": "projectid", "type": "string" }, { - "description": "the template display text", - "name": "displaytext", + "description": "the template name", + "name": "name", "type": "string" }, { - "description": "the type of the template", - "name": "templatetype", + "description": "true if template is sshkey enabled, false otherwise", + "name": "sshkeyenabled", + "type": "boolean" + }, + { + "description": "the ID of the OS type for this template.", + "name": "ostypeid", "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 template belongs", + "name": "domain", + "type": "string" + }, + { + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", + "type": "string" }, { "description": "true if the entity/resource has annotations", @@ -169762,70 +171218,115 @@ "type": "boolean" }, { - "description": "the project id of the template", - "name": "projectid", + "description": "the account id to which the template belongs", + "name": "accountid", "type": "string" }, { - "description": "The name of extension linked to this template", - "name": "extensionname", + "description": "the name of the OS type for this template.", + "name": "ostypename", "type": "string" }, { - "description": "the project name of the template", - "name": "project", + "description": "KVM Only: true if template is directly downloaded to Primary Storage bypassing Secondary Storage", + "name": "directdownload", + "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 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", + "description": "true if the template is ready to be deployed from, false otherwise.", + "name": "isready", "type": "boolean" }, { - "description": "the tag of this template", - "name": "templatetag", + "description": "the ID of the zone for this template", + "name": "zoneid", "type": "string" }, { - "description": "if Datadisk template, then id of the root disk template this template belongs to", - "name": "parenttemplateid", + "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": "checksum of the template", + "name": "checksum", + "type": "string" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "true if template requires HVM enabled, false otherwise", + "name": "requireshvm", + "type": "boolean" + }, + { + "description": "the account name to which the template belongs", + "name": "account", "type": "string" }, + {}, { - "description": "the id of userdata linked to this template", - "name": "userdataid", + "description": "the format of the template.", + "name": "format", + "type": "imageformat" + }, + { + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "if Datadisk template, then id of the root disk template this template belongs to", + "name": "parenttemplateid", "type": "string" }, {}, { - "description": "the template name", - "name": "name", + "description": "true if the reset password feature is enabled, false otherwise", + "name": "passwordenabled", + "type": "boolean" + }, + { + "description": "the template display text", + "name": "displaytext", "type": "string" }, { - "description": "The ID of extension linked to this template", - "name": "extensionid", + "description": "The name of extension linked to this template", + "name": "extensionname", "type": "string" }, { - "description": "the ID of the secondary storage host for the template", - "name": "hostid", + "description": "if root disk template, then ids of the datas disk templates this template owns", + "name": "childtemplates", + "type": "set" + }, + { + "description": "the status of the template", + "name": "status", "type": "string" }, { - "description": "the name of the secondary storage host for the template", - "name": "hostname", + "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", + "type": "boolean" + }, + { + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { @@ -169834,19 +171335,19 @@ "type": "boolean" }, { - "description": "true if template is sshkey enabled, false otherwise", - "name": "sshkeyenabled", - "type": "boolean" + "description": "CPU Arch of the template", + "name": "arch", + "type": "string" }, { - "description": "the name of the zone for this template", - "name": "zonename", + "description": "the ID of the secondary storage host for the template", + "name": "hostid", "type": "string" }, { - "description": "the status of the template", - "name": "status", - "type": "string" + "description": "the physical size of the template", + "name": "physicalsize", + "type": "long" } ], "since": "4.19.0" @@ -169857,31 +171358,37 @@ "name": "updateVPCOffering", "params": [ { - "description": "sort key of the VPC offering, integer", + "description": "the display text of the VPC offering", "length": 255, - "name": "sortkey", + "name": "displaytext", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", - "length": 4096, - "name": "domainid", + "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "length": 255, + "name": "state", "required": false, "type": "string" }, { - "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", + "description": "the name of the VPC offering", "length": 255, - "name": "zoneid", + "name": "name", "required": false, - "since": "4.13", "type": "string" }, { - "description": "update state for the VPC offering; supported states - Enabled/Disabled", + "description": "sort key of the VPC offering, integer", "length": 255, - "name": "state", + "name": "sortkey", + "required": false, + "type": "integer" + }, + { + "description": "the ID of the containing domain(s) as comma separated string, public for public offerings", + "length": 4096, + "name": "domainid", "required": false, "type": "string" }, @@ -169894,49 +171401,41 @@ "type": "uuid" }, { - "description": "the name of the VPC offering", - "length": 255, - "name": "name", - "required": false, - "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" } ], "related": "", "response": [ { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", "type": "string" }, + { + "description": "indicated if the offering can support region level vpc", + "name": "supportsregionLevelvpc", + "type": "boolean" + }, { "description": "true if network offering supports choosing AS numbers", "name": "specifyasnumber", "type": "boolean" }, - {}, { - "description": "the routing mode for the network offering, supported types are Static or Dynamic.", - "name": "routingmode", + "description": "the zone ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "zoneid", "type": "string" }, { - "description": "an alternate display text of the vpc offering.", - "name": "displaytext", + "description": "the internet protocol of the vpc offering", + "name": "internetprotocol", "type": "string" }, - {}, - { - "description": "the date this vpc offering was created", - "name": "created", - "type": "date" - }, { "description": "the list of supported services", "name": "service", @@ -169945,6 +171444,11 @@ "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", @@ -169954,27 +171458,22 @@ "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" }, - { - "description": "the service name", - "name": "name", - "type": "string" - }, { "description": "the service provider name", "name": "provider", "response": [ { - "description": "the physical network this belongs to", - "name": "physicalnetworkid", + "description": "services for this provider", + "name": "servicelist", + "type": "list" + }, + { + "description": "the destination physical network", + "name": "destinationphysicalnetworkid", "type": "string" }, { @@ -169983,89 +171482,71 @@ "type": "string" }, { - "description": "true if individual services can be enabled/disabled", - "name": "canenableindividualservice", - "type": "boolean" - }, - { - "description": "the provider name", - "name": "name", + "description": "the physical network this belongs to", + "name": "physicalnetworkid", "type": "string" }, { - "description": "the destination physical network", - "name": "destinationphysicalnetworkid", + "description": "state of the network provider", + "name": "state", "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" + "description": "true if individual services can be enabled/disabled", + "name": "canenableindividualservice", + "type": "boolean" } ], "type": "list" + }, + { + "description": "the service 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": "true if vpc offering is default, false otherwise", - "name": "isdefault", - "type": "boolean" + "description": "the date this vpc offering was created", + "name": "created", + "type": "date" }, { - "description": "state of the vpc offering. Can be Disabled/Enabled", - "name": "state", + "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", + "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 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", + "description": "the routing mode for the network offering, supported types are Static or Dynamic.", + "name": "routingmode", "type": "string" }, { - "description": "the internet protocol of the vpc offering", - "name": "internetprotocol", + "description": "an alternate display text of the vpc offering.", + "name": "displaytext", "type": "string" }, { @@ -170073,57 +171554,103 @@ "name": "fornsx", "type": "boolean" }, + { + "description": "true if vpc offering is default, false otherwise", + "name": "isdefault", + "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": "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": "state of the vpc offering. Can be Disabled/Enabled", + "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", + "type": "string" } ] }, { - "description": "Lists user two factor authenticator providers", + "description": "Lists authorized users who can used SAML SSO", "isasync": false, - "name": "listUserTwoFactorAuthenticatorProviders", + "name": "listSamlAuthorization", "params": [ { - "description": "List user two factor authenticator provider by name", + "description": "", "length": 255, - "name": "name", + "name": "page", + "required": false, + "type": "integer" + }, + { + "description": "List by keyword", + "length": 255, + "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" + }, + { + "description": "User uuid", + "length": 255, + "name": "userid", + "related": "", + "required": false, + "type": "uuid" } ], "related": "", "response": [ { - "description": "the user two factor authenticator provider name", - "name": "name", + "description": "the user ID", + "name": "userid", "type": "string" }, {}, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the SAML authorization status", + "name": "status", + "type": "boolean" + }, + { + "description": "the authorized Identity Provider ID", + "name": "idpid", "type": "string" }, { - "description": "the description of the user two factor authenticator provider", - "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" - }, - {} - ], - "since": "4.18.0" + } + ] }, { "description": "Lists extensions", @@ -170131,18 +171658,18 @@ "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.", + "description": "Name of the extension", "length": 255, - "name": "details", + "name": "name", "required": false, - "type": "list" + "type": "string" }, { - "description": "", + "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": "pagesize", + "name": "details", "required": false, - "type": "integer" + "type": "list" }, { "description": "List by keyword", @@ -170154,17 +171681,10 @@ { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" }, - { - "description": "Name of the extension", - "length": 255, - "name": "name", - "required": false, - "type": "string" - }, { "description": "uuid of the extension", "length": 255, @@ -170172,6 +171692,13 @@ "related": "listExtensions", "required": false, "type": "uuid" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" } ], "related": "", @@ -170182,9 +171709,9 @@ "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": "Description of the extension", @@ -170192,33 +171719,80 @@ "type": "string" }, { - "description": "The details of the extension", - "name": "details", - "type": "map" + "description": "Name of the extension", + "name": "name", + "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": "the details of the resource map", + "name": "details", + "type": "map" + }, + { + "description": "Type of the resource", + "name": "type", + "type": "string" + }, + { + "description": "ID of the resource associated with the extension", + "name": "id", + "type": "string" + }, + { + "description": "Name of the resource associated with this mapping", + "name": "name", + "type": "string" + } + ], + "type": "list" }, { "description": "Type of the extension", "name": "type", "type": "string" }, - { - "description": "Creation timestamp of the extension", - "name": "created", - "type": "date" - }, - {}, - {}, { "description": "ID of the extension", "name": "id", "type": "string" }, {}, + {}, + { + "description": "The details of the extension", + "name": "details", + "type": "map" + }, { "description": "The path of the entry point fo the extension", "name": "path", "type": "string" }, + { + "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": "True if the extension is added by admin", "name": "isuserdefined", @@ -170228,77 +171802,55 @@ "description": "The state of the extension", "name": "state", "type": "string" - }, + } + ], + "since": "4.21.0" + }, + { + "description": "Lists user two factor authenticator providers", + "isasync": false, + "name": "listUserTwoFactorAuthenticatorProviders", + "params": [ { - "description": "Name of the extension", + "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": "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 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" }, + {}, { "description": "the UUID of the latest async job acting on this object", "name": "jobid", "type": "string" - }, - { - "description": "True if the extension path is in ready state across management servers", - "name": "pathready", - "type": "boolean" } ], - "since": "4.21.0" + "since": "4.18.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.", "isasync": true, "name": "scaleVirtualMachine", "params": [ - { - "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", - "length": 255, - "name": "details", - "required": false, - "type": "map" - }, - { - "description": "Verify OK to Shrink", - "length": 255, - "name": "shrinkok", - "required": false, - "since": "4.17", - "type": "boolean" - }, { "description": "Flag for automatic migration of the root volume with new compute offering whenever migration is required to apply the offering", "length": 255, @@ -170315,6 +171867,14 @@ "since": "4.17", "type": "long" }, + { + "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,createVMFromBackup,importVm", + "required": true, + "type": "uuid" + }, { "description": "the ID of the service offering for the virtual machine", "length": 255, @@ -170324,12 +171884,19 @@ "type": "uuid" }, { - "description": "The ID of the virtual machine", + "description": "Verify OK to Shrink", "length": 255, - "name": "id", - "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" + "name": "shrinkok", + "required": false, + "since": "4.17", + "type": "boolean" + }, + { + "description": "name value pairs of custom parameters for cpuspeed, memory and cpunumber. example details[i].name=value", + "length": 255, + "name": "details", + "required": false, + "type": "map" }, { "description": "New maximum number of IOPS for the custom disk offering", @@ -170341,27 +171908,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" } ] }, @@ -170378,14 +171945,6 @@ "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" - }, { "description": "the ID of the egress firewall rule", "length": 255, @@ -170393,131 +171952,98 @@ "related": "", "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, + "name": "customid", + "required": false, + "since": "4.4", + "type": "string" } ], "related": "", "response": [ - { - "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 (,).", - "name": "destcidrlist", - "type": "string" - }, - { - "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": "is rule for display to the regular user", - "name": "fordisplay", - "type": "boolean" - }, - { - "description": "the public ip address for the firewall rule", - "name": "ipaddress", - "type": "string" - }, - { - "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", + "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": "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 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": "tag key name", - "name": "key", + "description": "resource type", + "name": "resourcetype", "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", + "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": "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": "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 traffic type for the firewall rule", + "name": "traffictype", + "type": "string" }, { - "description": "the ending port of firewall rule's port range", - "name": "endport", - "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 ID of the firewall rule", - "name": "id", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", + "type": "string" + }, + { + "description": "the protocol of the firewall rule", + "name": "protocol", "type": "string" }, { @@ -170525,21 +172051,62 @@ "name": "state", "type": "string" }, + { + "description": "the public ip address for the firewall rule", + "name": "ipaddress", + "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": "error code for this icmp message", + "name": "icmpcode", + "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 ending port of firewall rule's port range", + "name": "endport", + "type": "integer" + }, { "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 ID of the firewall rule", + "name": "id", "type": "string" }, { "description": "the public ip address id for the firewall rule", "name": "ipaddressid", "type": "string" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, + {}, + {}, + { + "description": "the network id of the firewall rule", + "name": "networkid", + "type": "string" } ], "since": "4.4" @@ -170550,29 +172117,20 @@ "name": "listOsCategories", "params": [ { - "description": "List available OS categories types for the zone", + "description": "List OS categories for which a VNF template is available", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isvnf", "required": false, "since": "4.21.0", - "type": "uuid" - }, - { - "description": "List OS category by name", - "length": 255, - "name": "name", - "required": false, - "since": "3.0.1", - "type": "string" + "type": "boolean" }, { - "description": "List OS categories types available for given CPU architecture", + "description": "List OS category by id", "length": 255, - "name": "arch", + "name": "id", + "related": "listOsCategories", "required": false, - "since": "4.21.0", - "type": "string" + "type": "uuid" }, { "description": "flag to display the resource image for the OS category", @@ -170583,82 +172141,85 @@ "type": "boolean" }, { - "description": "List by keyword", + "description": "List OS category by name", "length": 255, - "name": "keyword", + "name": "name", "required": false, + "since": "3.0.1", "type": "string" }, { - "description": "", + "description": "List available OS categories types for the zone", "length": 255, - "name": "pagesize", + "name": "zoneid", + "related": "listZones", "required": false, - "type": "integer" + "since": "4.21.0", + "type": "uuid" }, { - "description": "List OS category by id", + "description": "List available OS categories by featured or not", "length": 255, - "name": "id", - "related": "listOsCategories", + "name": "isfeatured", "required": false, - "type": "uuid" + "since": "4.21.0", + "type": "boolean" }, { - "description": "List available OS categories by featured or not", + "description": "List OS categories for which an ISO is available", "length": 255, - "name": "isfeatured", + "name": "isiso", "required": false, "since": "4.21.0", "type": "boolean" }, { - "description": "List OS categories for which a VNF template is available", + "description": "List by keyword", + "length": 255, + "name": "keyword", + "required": false, + "type": "string" + }, + { + "description": "", "length": 255, - "name": "isvnf", + "name": "page", "required": false, - "since": "4.21.0", - "type": "boolean" + "type": "integer" }, { - "description": "List OS categories for which an ISO is available", + "description": "List OS categories types available for given CPU architecture", "length": 255, - "name": "isiso", + "name": "arch", "required": false, "since": "4.21.0", - "type": "boolean" + "type": "string" }, { "description": "", "length": 255, - "name": "page", + "name": "pagesize", "required": false, "type": "integer" } ], "related": "", "response": [ + {}, { "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": "Date when the OS category was created.", + "name": "created", + "type": "date" }, { "description": "the UUID of the latest async job acting on this object", @@ -170666,14 +172227,20 @@ "type": "string" }, { - "description": "Date when the OS category was created.", - "name": "created", - "type": "date" + "description": "the ID of the OS category", + "name": "id", + "type": "string" }, { "description": "Whether the OS category is featured", "name": "isfeatured", "type": "boolean" + }, + {}, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -170682,14 +172249,6 @@ "isasync": false, "name": "listServiceOfferings", "params": [ - { - "description": "list objects by project; if projectid=-1 lists All VMs", - "length": 255, - "name": "projectid", - "related": "", - "required": false, - "type": "uuid" - }, { "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, @@ -170699,11 +172258,20 @@ "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": "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": "listall", + "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,createVMFromBackup,importVm", "required": false, - "type": "boolean" + "type": "uuid" + }, + { + "description": "the RAM memory that listed offering must support", + "length": 255, + "name": "memory", + "required": false, + "since": "4.15", + "type": "integer" }, { "description": "the storage type of the service offering. Values are local and shared.", @@ -170714,19 +172282,19 @@ "type": "string" }, { - "description": "", + "description": "List by keyword", "length": 255, - "name": "pagesize", + "name": "keyword", "required": false, - "type": "integer" + "type": "string" }, { - "description": "the CPU number that listed offerings must support", + "description": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", "length": 255, - "name": "cpunumber", + "name": "state", "required": false, - "since": "4.15", - "type": "integer" + "since": "4.19", + "type": "string" }, { "description": "The ID of the vGPU profile that listed offerings must support", @@ -170738,159 +172306,188 @@ "type": "uuid" }, { - "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 system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", + "description": "", "length": 255, - "name": "systemvmtype", + "name": "page", "required": false, - "type": "string" + "type": "integer" }, { - "description": "ID of the service offering", + "description": "the CPU speed that listed offerings must support", "length": 255, - "name": "id", - "related": "updateServiceOffering,listServiceOfferings", + "name": "cpuspeed", "required": false, - "type": "uuid" + "since": "4.15", + "type": "integer" }, { - "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", + "description": "is this a system vm offering", "length": 255, - "name": "isrecursive", + "name": "issystem", "required": false, "type": "boolean" }, { - "description": "list resources by account. Must be used with the domainId parameter.", + "description": "the system VM type. Possible types are \"consoleproxy\", \"secondarystoragevm\" or \"domainrouter\".", "length": 255, - "name": "account", + "name": "systemvmtype", "required": false, "type": "string" }, { - "description": "listed offerings support root disk encryption", + "description": "list only resources belonging to the domain specified", "length": 255, - "name": "encryptroot", + "name": "domainid", + "related": "listDomains", "required": false, - "since": "4.18", - "type": "boolean" + "type": "uuid" }, { - "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": "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": "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", + "name": "listall", "required": false, - "type": "uuid" + "type": "boolean" }, { - "description": "", + "description": "the CPU number that listed offerings must support", "length": 255, - "name": "page", + "name": "cpunumber", "required": false, + "since": "4.15", "type": "integer" }, { - "description": "id of zone disk offering is associated with", + "description": "defaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.", "length": 255, - "name": "zoneid", - "related": "listZones", + "name": "isrecursive", "required": false, - "since": "4.13", - "type": "uuid" + "type": "boolean" }, { - "description": "the RAM memory that listed offering must support", + "description": "ID of the service offering", "length": 255, - "name": "memory", + "name": "id", + "related": "updateServiceOffering,listServiceOfferings", "required": false, - "since": "4.15", - "type": "integer" + "type": "uuid" }, { - "description": "is this a system vm offering", + "description": "name of the service offering", "length": 255, - "name": "issystem", + "name": "name", "required": false, - "type": "boolean" + "type": "string" }, { "description": "The ID of the template that listed offerings must support", "length": 255, "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", "required": false, "since": "4.20.0", "type": "uuid" }, { - "description": "name of the service offering", + "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": "Filter by state of the service offering. Defaults to 'Active'. If set to 'all' shows both Active & Inactive offerings.", + "description": "id of zone disk offering is associated with", "length": 255, - "name": "state", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "4.19", - "type": "string" + "since": "4.13", + "type": "uuid" }, { - "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": "the CPU speed that listed offerings must support", + "description": "", "length": 255, - "name": "cpuspeed", + "name": "pagesize", "required": false, - "since": "4.15", "type": "integer" } ], "related": "updateServiceOffering", "response": [ + { + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" + }, { "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", + "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", + "name": "provisioningtype", + "type": "string" + }, + { + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" + }, + { + "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", "type": "boolean" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the cache mode to use for this disk offering. none, writeback or writethrough", - "name": "cacheMode", - "type": "string" + "description": "length (in second) of the burst", + "name": "diskIopsReadRateMaxLength", + "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the count of GPUs to attach ", + "name": "gpucount", "type": "integer" }, { @@ -170899,195 +172496,180 @@ "type": "string" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "deployment strategy used to deploy VM.", - "name": "deploymentplanner", + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "true if virtual machine root disk will be encrypted on storage", - "name": "encryptroot", + "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 display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "an alternate display text of the service offering.", + "name": "displaytext", "type": "string" }, - {}, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", - "type": "long" + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", + "type": "boolean" }, { - "description": "length (in second) of the burst", - "name": "diskIopsReadRateMaxLength", - "type": "long" + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "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 UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" }, { - "description": "the number of CPU", - "name": "cpunumber", + "description": "Instance lease duration (in days) for service offering", + "name": "leaseduration", "type": "integer" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", + "type": "long" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", + "description": "the maximum number of display heads", + "name": "maxheads", "type": "long" }, + { + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" + }, { "description": "length (in seconds) of the burst", "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "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": "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 ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { - "description": "the ha support in the service offering", - "name": "offerha", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", + "description": "deployment strategy used to deploy VM.", + "name": "deploymentplanner", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", - "type": "long" - }, - { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "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", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", "type": "boolean" }, { - "description": "the name of the gpu card to which service offering is linked", - "name": "gpucardname", - "type": "string" + "description": "is this a default system vm offering", + "name": "defaultuse", + "type": "boolean" }, { - "description": "Root disk size in GB", - "name": "rootdisksize", + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", - "type": "integer" - }, - { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", + "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domainid", "type": "string" }, { - "description": "data transfer rate in megabits per second allowed.", - "name": "networkrate", - "type": "integer" + "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 ID of the disk offering to which service offering is linked", - "name": "diskofferingid", + "description": "the name of the service offering", + "name": "name", "type": "string" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "the date this service offering was created", + "name": "created", + "type": "date" }, { - "description": "io requests read rate of the service offering", - "name": "diskIopsReadRate", + "description": "Root disk size in GB", + "name": "rootdisksize", "type": "long" }, { - "description": "the maximum number of display heads", - "name": "maxheads", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", "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 domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "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", + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { "description": "is this a system vm offering", @@ -171095,89 +172677,74 @@ "type": "boolean" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" - }, - {}, - { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", "type": "long" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", - "type": "long" + "description": "the id of the service offering", + "name": "id", + "type": "string" }, { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the domain name(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", + "name": "domain", + "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", + "description": "is true if the offering is customized", + "name": "iscustomized", "type": "boolean" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", - "type": "long" - }, - { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", - "type": "string" - }, - { - "description": "the storage type for this service offering", - "name": "storagetype", + "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 display text of the disk offering", + "name": "diskofferingdisplaytext", "type": "string" }, { - "description": "the name of the service offering", - "name": "name", + "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 max iops of the disk offering", - "name": "maxiops", + "description": "the min iops of the disk offering", + "name": "miniops", "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": "the number of CPU", + "name": "cpunumber", + "type": "integer" }, { - "description": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "the ha support in the service offering", + "name": "offerha", + "type": "boolean" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "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 service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", "type": "string" }, { - "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", - "name": "provisioningtype", + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", "type": "string" }, { @@ -171186,19 +172753,19 @@ "type": "integer" }, { - "description": "burst io requests read rate of the disk offering", - "name": "diskIopsReadRateMax", - "type": "long" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", - "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": "Instance lease duration (in days) for service offering", - "name": "leaseduration", - "type": "integer" + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", + "type": "string" } ] }, @@ -171208,91 +172775,94 @@ "name": "importVm", "params": [ { - "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) optional - if true, forces virt-v2v conversions to write directly on the provided storage pool (avoid using temporary conversion pool).", "length": 255, - "name": "forcemstoimportvmfiles", + "name": "forceconverttopool", "required": false, + "since": "4.22", "type": "boolean" }, { - "description": "vm and its volumes are allowed to migrate to different host/pool when offerings passed are incompatible with current host/pool", + "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": "migrateallowed", + "name": "convertinstancehostid", + "related": "", "required": false, - "type": "boolean" + "type": "uuid" }, { - "description": "hypervisor type of the host", + "description": "VM nic to ip address mapping using keys nic, ip4Address", "length": 255, - "name": "hypervisor", - "required": true, - "type": "string" + "name": "nicipaddresslist", + "required": false, + "type": "map" }, { - "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": "(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": "forced", + "name": "vcenter", "required": false, - "type": "boolean" + "type": "string" }, { - "description": "an optional account for the virtual machine. Must be used with domainId.", + "description": "the service offering for the virtual machine", "length": 255, - "name": "account", - "required": false, - "type": "string" + "name": "serviceofferingid", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { - "description": "the password for the host", + "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": "password", + "name": "forcemstoimportvmfiles", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "the zone ID", + "description": "the ID of the template for the virtual machine", "length": 255, - "name": "zoneid", - "related": "listZones", - "required": true, + "name": "templateid", + "related": "registerVnfTemplate,listVnfTemplates,updateVnfTemplate,listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos", + "required": false, "type": "uuid" }, { - "description": "Shared storage pool where disk is located", + "description": "import instance to the domain specified", "length": 255, - "name": "storageid", - "related": "", + "name": "domainid", + "related": "listDomains", "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware cluster.", + "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": "clustername", + "name": "migrateallowed", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "description": "hypervisor type of the host", "length": 255, - "name": "datacentername", - "required": false, + "name": "hypervisor", + "required": true, "type": "string" }, { - "description": "used to specify the custom parameters.", + "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", "length": 255, - "name": "details", + "name": "existingvcenterid", + "related": "", "required": false, - "type": "map" + "type": "uuid" }, { - "description": "the ID of the template for the virtual machine", + "description": "VM nic to network id mapping using keys nic and network", "length": 255, - "name": "templateid", - "related": "listTemplates,createTemplate,copyTemplate,registerTemplate,registerIso,copyIso,listIsos,registerVnfTemplate,listVnfTemplates,updateVnfTemplate", + "name": "nicnetworklist", "required": false, - "type": "uuid" + "type": "map" }, { "description": "the username for the host", @@ -171302,63 +172872,57 @@ "type": "string" }, { - "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", - "length": 255, - "name": "datadiskofferinglist", - "required": false, - "type": "map" - }, - { - "description": "path of the disk image", + "description": "an optional account for the virtual machine. Must be used with domainId.", "length": 255, - "name": "diskpath", + "name": "account", "required": false, "type": "string" }, { - "description": "import instance to the domain specified", + "description": "Shared storage pool where disk is located", "length": 255, - "name": "domainid", - "related": "listDomains", + "name": "storageid", + "related": "", "required": false, "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) UUID of a linked existing vCenter", + "description": "the cluster ID", "length": 255, - "name": "existingvcenterid", + "name": "clusterid", "related": "", - "required": false, + "required": true, "type": "uuid" }, { - "description": "VM nic to network id mapping using keys nic and network", + "description": "used to specify the custom parameters.", "length": 255, - "name": "nicnetworklist", + "name": "details", "required": false, "type": "map" }, { - "description": "Source location for Import", + "description": "datadisk template to disk-offering mapping using keys disk and diskOffering", "length": 255, - "name": "importsource", - "required": true, - "type": "string" + "name": "datadiskofferinglist", + "required": false, + "type": "map" }, { - "description": "Temp Path on external host for disk image copy", + "description": "import instance for the project", "length": 255, - "name": "temppath", + "name": "projectid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "the service offering for the virtual machine", + "description": "(only for importing VMs from VMware to KVM) optional - extra parameters to be passed on the virt-v2v command, if allowed by the administrator", "length": 255, - "name": "serviceofferingid", - "related": "updateServiceOffering", - "required": true, - "type": "uuid" + "name": "extraparams", + "required": false, + "since": "4.22", + "type": "string" }, { "description": "the network ID", @@ -171369,72 +172933,84 @@ "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) VMware ESXi host IP/Name.", + "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": "hostip", + "name": "convertinstancepoolid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "description": "the display name of the instance", "length": 255, - "name": "importinstancehostid", - "related": "", + "name": "displayname", "required": false, - "since": "4.19.2", - "type": "uuid" + "type": "string" }, { - "description": "the host name or IP address", + "description": "path of the disk image", "length": 255, - "name": "host", + "name": "diskpath", "required": false, "type": "string" }, { - "description": "(only for importing VMs from VMware to KVM) optional - the host to perform the virt-v2v conversion from VMware to KVM.", + "description": "Host where local disk is located", "length": 255, - "name": "convertinstancehostid", + "name": "hostid", "related": "", "required": false, "type": "uuid" }, { - "description": "Host where local disk is located", + "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": "hostid", + "name": "forced", + "required": false, + "type": "boolean" + }, + { + "description": "(only for importing VMs from VMware to KVM) optional - the host to import the converted instance from VMware to KVM.", + "length": 255, + "name": "importinstancehostid", "related": "", "required": false, + "since": "4.19.2", "type": "uuid" }, { - "description": "the cluster ID", + "description": "the name of the instance as it is known to the hypervisor", "length": 255, - "name": "clusterid", - "related": "", + "name": "name", "required": true, - "type": "uuid" + "type": "string" }, { - "description": "import instance for the project", + "description": "Source location for Import", "length": 255, - "name": "projectid", - "related": "", - "required": false, + "name": "importsource", + "required": true, + "type": "string" + }, + { + "description": "the zone ID", + "length": 255, + "name": "zoneid", + "related": "listZones", + "required": true, "type": "uuid" }, { - "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) VMware ESXi host IP/Name.", "length": 255, - "name": "convertinstancepoolid", - "related": "", + "name": "hostip", "required": false, - "type": "uuid" + "type": "string" }, { - "description": "the display name of the instance", + "description": "the host name or IP address", "length": 255, - "name": "displayname", + "name": "host", "required": false, "type": "string" }, @@ -171446,53 +173022,79 @@ "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) Name of VMware cluster.", "length": 255, - "name": "vcenter", + "name": "clustername", "required": false, "type": "string" }, { - "description": "the name of the instance as it is known to the hypervisor", + "description": "the password for the host", "length": 255, - "name": "name", - "required": true, + "name": "password", + "required": false, "type": "string" }, { - "description": "VM nic to ip address mapping using keys nic, ip4Address", + "description": "Temp Path on external host for disk image copy", "length": 255, - "name": "nicipaddresslist", + "name": "temppath", "required": false, - "type": "map" + "type": "string" + }, + { + "description": "(only for importing VMs from VMware to KVM) Name of VMware datacenter.", + "length": 255, + "name": "datacentername", + "required": false, + "type": "string" } ], - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", "response": [ { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", + "type": "string" + }, + { + "description": "an optional field whether to the display the vm to the end user or not.", + "name": "displayvm", + "type": "boolean" + }, + { + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "Guest vm Boot Type", + "name": "boottype", "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" + }, + { + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - {}, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the project id of the vm", + "name": "projectid", "type": "string" }, { @@ -171501,107 +173103,70 @@ "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 read in KiB", + "name": "diskkbsread", + "type": "long" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "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 backup offering of the virtual machine", - "name": "backupofferingid", + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "type": "integer" + }, + { + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "description": "device type of the root volume", + "name": "rootdevicetype", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "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": "Os type ID of the virtual machine", + "name": "guestosid", + "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" + }, + { + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, + { + "description": "device ID of the root volume", + "name": "rootdeviceid", + "type": "long" + }, { "description": "the list of nics associated with vm", "name": "nic", @@ -171611,54 +173176,104 @@ "name": "networkname", "type": "string" }, + { + "description": "the ip address of the nic", + "name": "ipaddress", + "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 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", + "description": "public IP address associated with this nic via Static nat rule", + "name": "publicip", "type": "string" }, { - "description": "the netmask of the nic", - "name": "netmask", + "description": "the type of the nic", + "name": "type", "type": "string" }, { - "description": "Type of adapter if available", - "name": "adaptertype", + "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": "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": "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": "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", + "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", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { - "description": "Id of the vpc to which the nic belongs", - "name": "vpcid", + "description": "the IPv6 address of network", + "name": "ip6address", "type": "string" }, { - "description": "the isolation uri of the nic", - "name": "isolationuri", + "description": "Type of adapter if available", + "name": "adaptertype", + "type": "string" + }, + { + "description": "the netmask of the nic", + "name": "netmask", + "type": "string" + }, + { + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { @@ -171667,18 +173282,18 @@ "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 ip address of the nic", - "name": "ipaddress", + "description": "Id of the vm to which the nic belongs", + "name": "virtualmachineid", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "description": "Id of the vpc to which the nic belongs", + "name": "vpcid", "type": "string" }, { @@ -171687,13 +173302,18 @@ "type": "list" }, { - "description": "the isolated private VLAN type if available", - "name": "isolatedpvlantype", + "description": "true if nic is default, false otherwise", + "name": "macaddress", "type": "string" }, { - "description": "Id of the vm to which the nic belongs", - "name": "virtualmachineid", + "description": "ID of the VLAN/VNI if available", + "name": "vlanid", + "type": "integer" + }, + { + "description": "the isolation uri of the nic", + "name": "isolationuri", "type": "string" }, { @@ -171702,101 +173322,83 @@ "type": "string" }, { - "description": "the Secondary ipv4 addr of nic", - "name": "secondaryip", - "type": "list" + "description": "the cidr of IPv6 network", + "name": "ip6cidr", + "type": "string" + } + ], + "type": "set" + }, + { + "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": "name of the vpc to which the nic belongs", - "name": "vpcname", + "description": "the account owning the affinity group", + "name": "account", "type": "string" }, { - "description": "the gateway of the nic", - "name": "gateway", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", + "description": "the domain name of the affinity group", + "name": "domain", "type": "string" }, { - "description": "the isolated private VLAN if available", - "name": "isolatedpvlan", - "type": "integer" + "description": "virtual machine IDs associated with this affinity group", + "name": "virtualmachineIds", + "type": "list" }, { - "description": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "description": "the ID of the affinity group", + "name": "id", "type": "string" }, { - "description": "Id of the NSX Logical Switch (if NSX based), null otherwise", - "name": "nsxlogicalswitch", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { - "description": "the IPv6 address of network", - "name": "ip6address", + "description": "the project name of the affinity group", + "name": "project", "type": "string" }, { - "description": "true if nic is default, false otherwise", - "name": "macaddress", + "description": "the name of the affinity group", + "name": "name", "type": "string" }, { - "description": "the broadcast uri of the nic", - "name": "broadcasturi", + "description": "the description of the affinity group", + "name": "description", "type": "string" }, { - "description": "the extra dhcp options on the nic", - "name": "extradhcpoption", + "description": "dedicated resources associated with this affinity group", + "name": "dedicatedresources", "type": "list" }, { - "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" } ], "type": "set" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", - "type": "string" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", - "type": "string" - }, - { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", - "type": "string" - }, - { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "type": "string" - }, - { - "description": "Instance lease expiry date", - "name": "leaseexpirydate", - "type": "date" - }, - { - "description": "User VM type", - "name": "vmtype", - "type": "string" - }, - { - "description": "the ID of the virtual machine", - "name": "id", + "description": "ssh key-pairs", + "name": "keypairs", "type": "string" }, { @@ -171805,144 +173407,75 @@ "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", + "description": "the maximum number of display heads", + "name": "maxheads", "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": "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", - "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", + "description": "OS name of the vm", + "name": "osdisplayname", "type": "string" }, { - "description": "the VM's primary IP address", - "name": "ipaddress", + "description": "the name of the host for the virtual machine", + "name": "hostname", "type": "string" }, + {}, { "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 incoming network traffic on the VM in KiB", - "name": "networkkbsread", - "type": "long" - }, { "description": "true if vm has delete protection.", "name": "deleteprotection", "type": "boolean" }, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the name of the ISO attached to the virtual machine", - "name": "isoname", - "type": "string" - }, - { - "description": "the number of vCPUs this virtual machine is using", - "name": "cpunumber", + "description": "Instance lease duration in days", + "name": "leaseduration", "type": "integer" }, { - "description": "ID of AutoScale VM group", - "name": "autoscalevmgroupid", + "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 vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", - "name": "isdynamicallyscalable", + "description": "the virtual network for the service offering", + "name": "forvirtualnetwork", "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "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 vm to the end user or not.", - "name": "displayvm", - "type": "boolean" - }, - { - "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 pool type of the virtual machine", - "name": "pooltype", + "description": "the account associated with the virtual machine", + "name": "account", "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": "the group ID of the virtual machine", "name": "groupid", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "the type of the template for the virtual machine", + "name": "templatetype", "type": "string" }, { - "description": "the count of GPUs on the virtual machine", - "name": "gpucount", - "type": "integer" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { "description": "the name of the service offering of the virtual machine", @@ -171950,119 +173483,158 @@ "type": "string" }, { - "description": "the userdata override policy with the userdata provided while deploying VM", - "name": "userdatapolicy", + "description": "the name of the availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "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", + "description": " an alternate display text of the template for the virtual machine", + "name": "templatedisplaytext", "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": "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": "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": "resource type", + "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" + } + ], + "type": "set" }, { - "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", "type": "string" }, + {}, { - "description": "the name of the virtual machine", - "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 maximum Y resolution", - "name": "maxresolutiony", + "description": "the maximum X resolution", + "name": "maxresolutionx", "type": "long" }, { - "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 target memory in VM (KiB)", - "name": "memorytargetkbs", - "type": "long" + "description": "the date when this virtual machine was created", + "name": "created", + "type": "date" }, { - "description": "public IP address id associated with vm 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": "Guest vm Boot Type", - "name": "boottype", + "description": "the ID of the virtual machine", + "name": "id", "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 format of the template for the virtual machine", - "name": "templateformat", + "description": "the ID of the host for the virtual machine", + "name": "hostid", "type": "string" }, { - "description": "the write (IO) of disk on the VM", - "name": "diskiowrite", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "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 user's name who deployed the virtual machine", - "name": "username", + "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 pool type of the virtual machine", + "name": "pooltype", + "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "VNF details", + "name": "vnfdetails", + "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": "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 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", @@ -172072,6 +173644,11 @@ "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", @@ -172083,13 +173660,8 @@ "type": "string" }, { - "description": "the starting IP of the security group rule", - "name": "startport", - "type": "integer" - }, - { - "description": "security group name", - "name": "securitygroupname", + "description": "the id of the security group rule", + "name": "ruleid", "type": "string" }, { @@ -172097,33 +173669,38 @@ "name": "icmpcode", "type": "integer" }, + { + "description": "the starting IP of the security group rule", + "name": "startport", + "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": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { - "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 ID of the domain associated with the tag", + "name": "domainid", "type": "string" }, { @@ -172132,28 +173709,28 @@ "type": "string" }, { - "description": "resource type", - "name": "resourcetype", + "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 account associated with the tag", + "name": "account", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "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": "tag value", - "name": "value", + "description": "customer associated with the tag", + "name": "customer", "type": "string" } ], @@ -172165,137 +173742,35 @@ "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 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", + "description": "security group name", + "name": "securitygroupname", "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", + "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 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 protocol of the security group rule", - "name": "protocol", + "description": "security group name", + "name": "securitygroupname", "type": "string" }, { - "description": "the ending IP of the security group rule ", - "name": "endport", - "type": "integer" - }, - { - "description": "the starting IP of the security group rule", - "name": "startport", + "description": "the code for the ICMP message response", + "name": "icmpcode", "type": "integer" }, { @@ -172304,23 +173779,23 @@ "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": "account owning the security group rule", - "name": "account", + "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": "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" }, { @@ -172328,200 +173803,249 @@ "name": "tags", "response": [ { - "description": "the ID of the domain associated with the tag", - "name": "domainid", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "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" }, { - "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": "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" }, { - "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": "tag key name", - "name": "key", + "description": "tag value", + "name": "value", "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 type of the ICMP message response", + "name": "icmptype", + "type": "integer" } ], "type": "set" }, { - "description": "the name of the security group", - "name": "name", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the state of the virtual machine", - "name": "state", - "type": "string" - }, - { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", - "type": "string" - }, - { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", - "type": "string" - }, - { - "description": "the name of userdata used for the VM", - "name": "userdataname", - "type": "string" - }, - { - "description": "the total number of network traffic bytes received", - "name": "receivedbytes", - "type": "long" - }, - { - "description": "the list of resource tags associated", - "name": "tags", - "response": [ - { - "description": "resource type", - "name": "resourcetype", - "type": "string" + "description": "the number of virtualmachines associated with this securitygroup", + "name": "virtualmachinecount", + "type": "integer" }, { - "description": "the project name where tag belongs to", - "name": "project", + "description": "the ID of the security group", + "name": "id", "type": "string" }, { - "description": "the domain associated with the tag", + "description": "the domain name of the security group", "name": "domain", "type": "string" }, { - "description": "tag key name", - "name": "key", + "description": "the account owning the security group", + "name": "account", "type": "string" }, { - "description": "id of the resource", - "name": "resourceid", + "description": "the description of the security group", + "name": "description", "type": "string" }, { - "description": "tag value", - "name": "value", + "description": "the project name of the group", + "name": "project", "type": "string" }, { - "description": "the project id the tag belongs to", - "name": "projectid", + "description": "the domain ID of the security group", + "name": "domainid", "type": "string" }, { - "description": "the ID of the domain associated with the tag", - "name": "domainid", - "type": "string" + "description": "the list of virtualmachine ids associated with this securitygroup", + "name": "virtualmachineids", + "type": "set" }, { - "description": "customer associated with the tag", - "name": "customer", + "description": "the name of the security group", + "name": "name", "type": "string" }, { - "description": "path of the Domain associated with the tag", + "description": "path of the Domain the security group belongs to", "name": "domainpath", "type": "string" }, { - "description": "the account associated with the tag", - "name": "account", - "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 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": "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": "tag key name", + "name": "key", + "type": "string" + }, + { + "description": "id of the resource", + "name": "resourceid", + "type": "string" + }, + { + "description": "the account associated with the tag", + "name": "account", + "type": "string" + }, + { + "description": "the domain associated with the tag", + "name": "domain", + "type": "string" + } + ], + "type": "set" } ], "type": "set" }, { - "description": "the virtual network for the service offering", - "name": "forvirtualnetwork", + "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 the password rest feature is enabled, false otherwise", + "name": "passwordenabled", "type": "boolean" }, { - "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": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "the state of the virtual machine", + "name": "state", "type": "string" }, { - "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": "publicip", "type": "string" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the project name of the vm", + "name": "project", "type": "string" }, { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "description": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", + "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": "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": "publicip", + "description": "the incoming network traffic on the VM in KiB", + "name": "networkkbsread", + "type": "long" + }, + { + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { @@ -172529,60 +174053,79 @@ "name": "ostypeid", "type": "string" }, - {}, { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", - "type": "string" + "description": "the outgoing network traffic on the host in KiB", + "name": "networkkbswrite", + "type": "long" }, { - "description": "the name of the template for the virtual machine", - "name": "templatename", + "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", + "name": "displayname", "type": "string" }, { - "description": "ssh key-pairs", - "name": "keypairs", + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the speed of each vCPU", + "name": "cpuspeed", + "type": "integer" + }, + { + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "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 speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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", + "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": "true if high-availability is enabled, false otherwise", + "name": "haenable", + "type": "boolean" }, { - "description": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "description": "the password (if exists) of the virtual machine", + "name": "password", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" + }, + { + "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" }, { @@ -172591,38 +174134,78 @@ "type": "string" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "description": "the user's name who deployed the virtual machine", + "name": "username", "type": "string" }, { - "description": "user generated name. The name of the virtual machine is returned if no displayname exists.", - "name": "displayname", + "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 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 control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, + { + "description": "the VM's disk write in KiB", + "name": "diskkbswrite", + "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 user's ID who deployed the virtual machine", - "name": "userid", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project name of the vm", - "name": "project", + "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": "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" + }, + { + "description": "the name of the backup offering of the virtual machine", + "name": "backupofferingname", + "type": "string" + }, + { + "description": "the name of the ISO attached to the virtual machine", + "name": "isoname", "type": "string" } ], @@ -172634,20 +174217,20 @@ "name": "removeFromGlobalLoadBalancerRule", "params": [ { - "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" }, { - "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" } ], "response": [ @@ -172657,21 +174240,21 @@ "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" } ] }, @@ -172680,13 +174263,6 @@ "isasync": false, "name": "listAffinityGroupTypes", "params": [ - { - "description": "", - "length": 255, - "name": "pagesize", - "required": false, - "type": "integer" - }, { "description": "", "length": 255, @@ -172700,26 +174276,33 @@ "name": "keyword", "required": false, "type": "string" + }, + { + "description": "", + "length": 255, + "name": "pagesize", + "required": false, + "type": "integer" } ], "related": "", "response": [ + {}, + {}, { "description": "the type of the affinity group", "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 current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" } ] }, @@ -172728,6 +174311,29 @@ "isasync": false, "name": "listCapacity", "params": [ + { + "description": "Sort the results. Available values: Usage", + "length": 255, + "name": "sortby", + "required": false, + "since": "3.0.0", + "type": "string" + }, + { + "description": "Tag for the resource type", + "length": 255, + "name": "tag", + "required": false, + "since": "4.20.0", + "type": "string" + }, + { + "description": "", + "length": 255, + "name": "page", + "required": false, + "type": "integer" + }, { "description": "", "length": 255, @@ -172736,19 +174342,19 @@ "type": "integer" }, { - "description": "List by keyword", + "description": "lists capacity by the Pod ID", "length": 255, - "name": "keyword", + "name": "podid", + "related": "", "required": false, - "type": "string" + "type": "uuid" }, { - "description": "lists capacity by the Cluster ID", + "description": "lists capacity by the Zone ID", "length": 255, - "name": "clusterid", - "related": "", + "name": "zoneid", + "related": "listZones", "required": false, - "since": "3.0.0", "type": "uuid" }, { @@ -172767,56 +174373,34 @@ "type": "boolean" }, { - "description": "Sort the results. Available values: Usage", - "length": 255, - "name": "sortby", - "required": false, - "since": "3.0.0", - "type": "string" - }, - { - "description": "lists capacity by the Pod ID", + "description": "lists capacity by the Cluster ID", "length": 255, - "name": "podid", + "name": "clusterid", "related": "", "required": false, + "since": "3.0.0", "type": "uuid" }, { - "description": "lists capacity by the Zone ID", - "length": 255, - "name": "zoneid", - "related": "listZones", - "required": false, - "type": "uuid" - }, - { - "description": "Tag for the resource type", + "description": "List by keyword", "length": 255, - "name": "tag", + "name": "keyword", "required": false, - "since": "4.20.0", "type": "string" - }, - { - "description": "", - "length": 255, - "name": "page", - "required": false, - "type": "integer" } ], "related": "", "response": [ + {}, { - "description": "the percentage of capacity currently in use", - "name": "percentused", + "description": "the Zone ID", + "name": "zoneid", "type": "string" }, { - "description": "the capacity currently in use", - "name": "capacityused", - "type": "long" + "description": "the Cluster ID", + "name": "clusterid", + "type": "string" }, { "description": "the total capacity available", @@ -172824,8 +174408,14 @@ "type": "long" }, { - "description": "the UUID of the latest async job acting on this object", - "name": "jobid", + "description": "The tag for the capacity type", + "name": "tag", + "type": "string" + }, + {}, + { + "description": "the Pod name", + "name": "podname", "type": "string" }, { @@ -172834,19 +174424,18 @@ "type": "string" }, { - "description": "the Zone ID", - "name": "zoneid", + "description": "the Zone name", + "name": "zonename", "type": "string" }, { - "description": "the Cluster ID", - "name": "clusterid", - "type": "string" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, - {}, { - "description": "The tag for the capacity type", - "name": "tag", + "description": "the Pod ID", + "name": "podid", "type": "string" }, { @@ -172855,8 +174444,13 @@ "type": "long" }, { - "description": "the Cluster name", - "name": "clustername", + "description": "the capacity currently in use", + "name": "capacityused", + "type": "long" + }, + { + "description": "the percentage of capacity currently in use", + "name": "percentused", "type": "string" }, { @@ -172864,25 +174458,14 @@ "name": "type", "type": "short" }, - {}, - { - "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 Pod ID", - "name": "podid", + "description": "the Cluster name", + "name": "clustername", "type": "string" }, { - "description": "the Pod name", - "name": "podname", + "description": "the UUID of the latest async job acting on this object", + "name": "jobid", "type": "string" } ] @@ -172893,10 +174476,11 @@ "name": "updateServiceOffering", "params": [ { - "description": "the display text of the service offering to be updated", + "description": "the host tag for this service offering.", "length": 255, - "name": "displaytext", + "name": "hosttags", "required": false, + "since": "4.16", "type": "string" }, { @@ -172907,12 +174491,12 @@ "type": "string" }, { - "description": "the host tag for this service offering.", + "description": "the ID of the service offering to be updated", "length": 255, - "name": "hosttags", - "required": false, - "since": "4.16", - "type": "string" + "name": "id", + "related": "updateServiceOffering", + "required": true, + "type": "uuid" }, { "description": "the name of the service offering to be updated", @@ -172921,20 +174505,6 @@ "required": false, "type": "string" }, - { - "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": "sort key of the service offering, integer", - "length": 255, - "name": "sortkey", - "required": false, - "type": "integer" - }, { "description": "Whether to cleanup VM and its associated resource upon expunge", "length": 255, @@ -172943,14 +174513,6 @@ "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" - }, { "description": "Details in key/value pairs using format externaldetails[i].keyname=keyvalue. Example: externaldetails[0].endpoint.url=urlvalue", "length": 255, @@ -172959,6 +174521,20 @@ "since": "4.21.0", "type": "map" }, + { + "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": "sort key of the service offering, integer", + "length": 255, + "name": "sortkey", + "required": false, + "type": "integer" + }, { "description": "the ID of the containing zone(s) as comma separated string, all for all zones offerings", "length": 255, @@ -172967,6 +174543,13 @@ "since": "4.13", "type": "string" }, + { + "description": "the display text of the service offering to be updated", + "length": 255, + "name": "displaytext", + "required": false, + "type": "string" + }, { "description": "comma-separated list of tags for the service offering, tags should match with existing storage pool tags", "length": 255, @@ -172974,45 +174557,37 @@ "required": false, "since": "4.16", "type": "string" + }, + { + "description": "Optional boolean field, which indicates if external details should be cleaned up or not (If set to true, external details removed for this offering, externaldetails field ignored; if false or not set, no action)", + "length": 255, + "name": "cleanupexternaldetails", + "required": false, + "since": "4.22.0", + "type": "boolean" } ], "related": "", "response": [ { - "description": "is this a the systemvm type for system vm offering", - "name": "systemvmtype", + "description": "the host tag for the service offering", + "name": "hosttags", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesWriteRateMaxLength", - "type": "long" - }, - { - "description": "the video RAM size in MB", - "name": "videoram", + "description": "burst bytes read rate of the disk offering", + "name": "diskBytesReadRateMax", "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", + "description": "the name of the service offering", + "name": "name", "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": "Instance lease duration (in days) for service offering", + "name": "leaseduration", + "type": "integer" }, { "description": "length (in second) of the burst", @@ -173020,59 +174595,55 @@ "type": "long" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "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 name of the gpu card to which service offering is linked", - "name": "gpucardname", + "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" + "description": "data transfer rate in megabits per second allowed.", + "name": "networkrate", + "type": "integer" }, + {}, { - "description": "burst io requests write rate of the disk offering", - "name": "diskIopsWriteRateMax", - "type": "long" + "description": "the current status of the latest async job acting on this object", + "name": "jobstatus", + "type": "integer" }, { - "description": "Action to be taken once lease is over", - "name": "leaseexpiryaction", + "description": "the id of the service offering", + "name": "id", "type": "string" }, { - "description": "the tags for the service offering", - "name": "storagetags", - "type": "string" + "description": "restrict the CPU usage to committed service offering", + "name": "limitcpuuse", + "type": "boolean" }, { - "description": "bytes read rate of the service offering", - "name": "diskBytesReadRate", + "description": "the max iops of the disk offering", + "name": "maxiops", "type": "long" }, { - "description": "io requests write rate of the service offering", - "name": "diskIopsWriteRate", + "description": "the date this service offering was created", + "name": "created", + "type": "date" + }, + { + "description": "burst bytes write rate of the disk offering", + "name": "diskBytesWriteRateMax", "type": "long" }, { - "description": "the id of the service offering", - "name": "id", + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" }, { - "description": "the clock rate CPU speed in Mhz", - "name": "cpuspeed", - "type": "integer" + "description": "the ID of the vgpu profile to which service offering is linked", + "name": "vgpuprofileid", + "type": "string" }, { "description": "provisioning type used to create volumes. Valid values are thin, sparse, fat.", @@ -173080,14 +174651,14 @@ "type": "string" }, { - "description": "bytes write rate of the service offering", - "name": "diskBytesWriteRate", + "description": "the min iops of the disk offering", + "name": "miniops", "type": "long" }, { - "description": "burst bytes write rate of the disk offering", - "name": "diskBytesWriteRateMax", - "type": "long" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { "description": "the ha support in the service offering", @@ -173095,23 +174666,54 @@ "type": "boolean" }, { - "description": "is this a system vm offering", - "name": "issystem", - "type": "boolean" + "description": "the clock rate CPU speed in Mhz", + "name": "cpuspeed", + "type": "integer" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", + "description": "bytes read rate of the service offering", + "name": "diskBytesReadRate", "type": "long" }, + { + "description": "the vsphere storage policy tagged to the service offering in case of VMware", + "name": "vspherestoragepolicy", + "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": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", + "type": "string" + }, { "description": "deployment strategy used to deploy VM.", "name": "deploymentplanner", "type": "string" }, { - "description": "the min iops of the disk offering", - "name": "miniops", + "description": "an alternate display text of the service offering.", + "name": "displaytext", + "type": "string" + }, + {}, + { + "description": "the number of CPU", + "name": "cpunumber", + "type": "integer" + }, + { + "description": "Whether to cleanup VM and its associated resource upon expunge", + "name": "purgeresources", + "type": "boolean" + }, + { + "description": "burst io requests read rate of the disk offering", + "name": "diskIopsReadRateMax", "type": "long" }, { @@ -173120,29 +174722,23 @@ "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", + "description": "length (in seconds) of the burst", + "name": "diskIopsWriteRateMaxLength", "type": "long" }, { - "description": "the count of GPUs to attach ", - "name": "gpucount", - "type": "integer" + "description": "bytes write rate of the service offering", + "name": "diskBytesWriteRate", + "type": "long" }, { - "description": "restrict the CPU usage to committed service offering", - "name": "limitcpuuse", + "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": "true if virtual machine needs to be dynamically scalable of cpu or memory", - "name": "dynamicscalingenabled", + "description": "true if disk offering uses custom iops, false otherwise", + "name": "iscustomizediops", "type": "boolean" }, { @@ -173151,168 +174747,163 @@ "type": "boolean" }, { - "description": "true if disk offering uses custom iops, false otherwise", - "name": "iscustomizediops", + "description": "true if virtual machine root disk will be encrypted on storage", + "name": "encryptroot", "type": "boolean" }, { - "description": "burst bytes read rate of the disk offering", - "name": "diskBytesReadRateMax", - "type": "long" + "description": "the storage type for this service offering", + "name": "storagetype", + "type": "string" }, { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Action to be taken once lease is over", + "name": "leaseexpiryaction", "type": "string" }, { - "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": "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": "the count of GPUs to attach ", + "name": "gpucount", + "type": "integer" }, { - "description": "the domain ID(s) this disk offering belongs to. Ignore this information as it is not currently applicable.", - "name": "domainid", + "description": "the cache mode to use for this disk offering. none, writeback, writethrough or hypervisor default", + "name": "cacheMode", "type": "string" }, { - "description": "is this a default system vm offering", - "name": "defaultuse", - "type": "boolean" - }, - { - "description": "additional key/value details tied with this service offering", - "name": "serviceofferingdetails", - "type": "map" + "description": "the maximum X resolution", + "name": "maxresolutionx", + "type": "long" }, { - "description": "whether GPU device is used for display or not ", - "name": "gpudisplay", - "type": "boolean" + "description": "Root disk size in GB", + "name": "rootdisksize", + "type": "long" }, { - "description": "the storage type for this service offering", - "name": "storagetype", + "description": "the tags for the service offering", + "name": "storagetags", "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskBytesReadRateMaxLength", - "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": "Root disk size in GB", - "name": "rootdisksize", + "description": "the maximum Y resolution", + "name": "maxresolutiony", "type": "long" }, { - "description": "the current status of the latest async job acting on this object", - "name": "jobstatus", + "description": "the memory in MB", + "name": "memory", "type": "integer" }, { - "description": "is true if the offering is customized", - "name": "iscustomized", + "description": "is this a default system vm offering", + "name": "defaultuse", "type": "boolean" }, { - "description": "true if the entity/resource has annotations", - "name": "hasannotations", + "description": "is this a the systemvm type for system vm offering", + "name": "systemvmtype", + "type": "string" + }, + { + "description": "the maximum number of display heads", + "name": "maxheads", + "type": "long" + }, + { + "description": "true if virtual machine needs to be dynamically scalable of cpu or memory", + "name": "dynamicscalingenabled", "type": "boolean" }, { - "description": "state of the service offering", - "name": "state", - "type": "string" + "description": "io requests write rate of the service offering", + "name": "diskIopsWriteRate", + "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": "name of the disk offering", - "name": "diskofferingname", - "type": "string" + "description": "burst io requests write rate of the disk offering", + "name": "diskIopsWriteRateMax", + "type": "long" }, { - "description": "the host tag for the service offering", - "name": "hosttags", - "type": "string" + "description": "length (in seconds) of the burst", + "name": "diskBytesReadRateMaxLength", + "type": "long" }, { - "description": "an alternate display text of the service offering.", - "name": "displaytext", + "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 maximum number of display heads", - "name": "maxheads", - "type": "long" + "description": "the display text of the disk offering", + "name": "diskofferingdisplaytext", + "type": "string" }, { - "description": "the max iops of the disk offering", - "name": "maxiops", + "description": "length (in seconds) of the burst", + "name": "diskBytesWriteRateMaxLength", "type": "long" }, { - "description": "the vsphere storage policy tagged to the service offering in case of VMware", - "name": "vspherestoragepolicy", - "type": "string" + "description": "io requests read rate of the service offering", + "name": "diskIopsReadRate", + "type": "long" }, { - "description": "the date this service offering was created", - "name": "created", - "type": "date" + "description": "additional key/value details tied with this service offering", + "name": "serviceofferingdetails", + "type": "map" }, { - "description": "Whether to cleanup VM and its associated resource upon expunge", - "name": "purgeresources", - "type": "boolean" + "description": "name of the disk offering", + "name": "diskofferingname", + "type": "string" }, { - "description": "the memory in MB", - "name": "memory", - "type": "integer" + "description": "the ID of the disk offering to which service offering is linked", + "name": "diskofferingid", + "type": "string" }, { - "description": "length (in seconds) of the burst", - "name": "diskIopsWriteRateMaxLength", + "description": "the video RAM size in MB", + "name": "videoram", "type": "long" }, { - "description": "the name of the service offering", - "name": "name", + "description": "state of the service offering", + "name": "state", "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", + "description": "whether GPU device is used for display or not ", + "name": "gpudisplay", "type": "boolean" }, { - "description": "Instance lease duration (in days) for service offering", - "name": "leaseduration", - "type": "integer" - }, - { - "description": "the display text of the disk offering", - "name": "diskofferingdisplaytext", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" } ] @@ -173326,7 +174917,7 @@ "description": "The ID of the virtual machine", "length": 255, "name": "id", - "related": "scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,stopVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", "required": true, "type": "uuid" }, @@ -173338,162 +174929,563 @@ "type": "boolean" } ], - "related": "scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup,deployVnfAppliance,listVnfAppliances", + "related": "deployVnfAppliance,listVnfAppliances,scaleVirtualMachine,attachIso,detachIso,updateVMAffinityGroup,addNicToVirtualMachine,removeNicFromVirtualMachine,updateDefaultNicForVirtualMachine,deployVirtualMachine,destroyVirtualMachine,rebootVirtualMachine,resetPasswordForVirtualMachine,resetSSHKeyForVirtualMachine,restoreVirtualMachine,startVirtualMachine,stopVirtualMachine,updateVirtualMachine,changeServiceForVirtualMachine,revertToVMSnapshot,listVirtualMachines,createVMFromBackup", "response": [ { - "description": "the format of the template for the virtual machine", - "name": "templateformat", + "description": "CPU arch of the VM", + "name": "arch", "type": "string" }, { - "description": "State of the Service from LB rule", - "name": "servicestate", + "description": "the date when this virtual machine was updated last time", + "name": "lastupdated", + "type": "date" + }, + { + "description": "the target memory in VM (KiB)", + "name": "memorytargetkbs", + "type": "long" + }, + { + "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": "Guest vm Boot Type", + "name": "boottype", + "type": "string" + }, + { + "description": "device type of the root volume", + "name": "rootdevicetype", + "type": "string" + }, + { + "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 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 outgoing network traffic on the host in KiB", "name": "networkkbswrite", "type": "long" }, { - "description": "User VM type", - "name": "vmtype", - "type": "string" + "description": "Base64 string representation of the resource icon", + "name": "icon", + "type": "resourceiconresponse" }, { - "description": "the VM's disk write in KiB", - "name": "diskkbswrite", + "description": "the memory allocated for the virtual machine", + "name": "memory", + "type": "integer" + }, + { + "description": "the total number of network traffic bytes sent", + "name": "sentbytes", "type": "long" }, { - "description": "true if vm has delete protection.", - "name": "deleteprotection", - "type": "boolean" + "description": "User VM type", + "name": "vmtype", + "type": "string" }, { - "description": "CPU arch of the VM", - "name": "arch", + "description": "Instance lease expiry action", + "name": "leaseexpiryaction", + "type": "string" + }, + { + "description": "list of variables and values for the variables declared in userdata", + "name": "userdatadetails", "type": "string" }, - {}, { "description": "ID of AutoScale VM group", "name": "autoscalevmgroupid", "type": "string" }, { - "description": "the maximum X resolution", - "name": "maxresolutionx", - "type": "long" + "description": "Instance lease duration in days", + "name": "leaseduration", + "type": "integer" }, { - "description": "device type of the root volume", - "name": "rootdevicetype", + "description": "the name of userdata used for the VM", + "name": "userdataname", "type": "string" }, { - "description": "Vm details in key/value pairs.", - "name": "details", - "type": "map" + "description": "the video RAM size in MB", + "name": "videoram", + "type": "long" }, { - "description": "the id of userdata used for the VM", - "name": "userdataid", - "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": "Instance lease expiry action", - "name": "leaseexpiryaction", + "description": "the password (if exists) of the virtual machine", + "name": "password", "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 ID of the service offering of the virtual machine", - "name": "serviceofferingid", - "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": "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": "tag key name", + "name": "key", + "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 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" + } + ], + "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", + "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 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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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": "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 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": "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 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" + } + ], + "type": "set" + }, + { + "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 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": "security group name", + "name": "securitygroupname", + "type": "string" + }, + { + "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": "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" + }, + { + "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 list of resource tags associated with the rule", + "name": "tags", + "response": [ + { + "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 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": "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": "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": "set" + } + ], + "type": "set" + }, + { + "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 description of the security group", + "name": "description", + "type": "string" + }, + { + "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 project name of the group", + "name": "project", + "type": "string" + } + ], + "type": "set" }, { - "description": "the memory allocated for the virtual machine", - "name": "memory", - "type": "integer" + "description": "the type of the template for the virtual machine", + "name": "templatetype", + "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 ID of the availability zone for the virtual machine", - "name": "zoneid", + "description": "path of the domain in which the virtual machine exists", + "name": "domainpath", "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": "device ID of the root volume", - "name": "rootdeviceid", - "type": "long" + "description": "Guest vm Boot Mode", + "name": "bootmode", + "type": "string" }, { - "description": "the name of the domain in which the virtual machine exists", - "name": "domain", + "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 availability zone for the virtual machine", + "name": "zonename", "type": "string" }, { - "description": "the video RAM size in MB", - "name": "videoram", + "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", + "type": "string" }, { - "description": "Os type ID of the virtual machine", - "name": "guestosid", + "description": "the ID of the service offering of the virtual machine", + "name": "serviceofferingid", "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": "list of affinity groups associated with the virtual machine", "name": "affinitygroup", "response": [ { - "description": "the domain name of the affinity group", - "name": "domain", + "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" }, { - "description": "the project ID of the affinity group", - "name": "projectid", + "description": "the domain ID of the affinity group", + "name": "domainid", "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": "the ID of the affinity group", @@ -173501,33 +175493,33 @@ "type": "string" }, { - "description": "the domain ID of the affinity group", - "name": "domainid", + "description": "the project ID of the affinity group", + "name": "projectid", "type": "string" }, { - "description": "the type of the affinity group", - "name": "type", + "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 name of the affinity group", + "name": "name", + "type": "string" }, { - "description": "dedicated resources associated with this affinity group", - "name": "dedicatedresources", - "type": "list" + "description": "the domain name of the affinity group", + "name": "domain", + "type": "string" }, { - "description": "the description of the affinity group", - "name": "description", + "description": "path of the Domain the affinity group belongs to", + "name": "domainpath", "type": "string" }, { - "description": "the account owning the affinity group", - "name": "account", + "description": "the type of the affinity group", + "name": "type", "type": "string" }, { @@ -173539,213 +175531,178 @@ "type": "set" }, { - "description": "the maximum number of display heads", - "name": "maxheads", - "type": "long" - }, - { - "description": "Guest vm Boot Type", - "name": "boottype", - "type": "string" - }, - { - "description": "Name of AutoScale VM group", - "name": "autoscalevmgroupname", - "type": "string" - }, - { - "description": "list of variables and values for the variables declared in userdata", - "name": "userdatadetails", - "type": "string" + "description": "Vm details in key/value pairs.", + "name": "details", + "type": "map" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", - "name": "instancename", - "type": "string" + "description": "the maximum Y resolution", + "name": "maxresolutiony", + "type": "long" }, { - "description": "the name of userdata used for the VM", - "name": "userdataname", + "description": "Base64 string containing the user data", + "name": "userdata", "type": "string" }, { - "description": "Guest vm Boot Mode", - "name": "bootmode", + "description": "the ID of the backup offering of the virtual machine", + "name": "backupofferingid", "type": "string" }, { - "description": "the group ID of the virtual machine", - "name": "groupid", + "description": "the ID of the gpu card to which service offering is linked", + "name": "gpucardid", "type": "string" }, { - "description": "the ID of the virtual machine", - "name": "id", + "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 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": "the VM's primary IP address", + "name": "ipaddress", "type": "string" }, - { - "description": "the total number of network traffic bytes sent", - "name": "sentbytes", - "type": "long" - }, {}, { - "description": "the type of the template for the virtual machine", - "name": "templatetype", - "type": "string" - }, - { - "description": "the ID of the gpu card to which service offering is linked", - "name": "gpucardid", + "description": "Os type ID of the virtual machine", + "name": "guestosid", "type": "string" }, { - "description": "the vGPU type used by the virtual machine", - "name": "vgpu", + "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 date when this virtual machine was created", - "name": "created", - "type": "date" - }, - { - "description": "OS name of the vm", - "name": "osdisplayname", + "description": "the account associated with the virtual machine", + "name": "account", "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 domain in which the virtual machine exists", + "name": "domain", "type": "string" }, { - "description": "the name of the host for the virtual machine", - "name": "hostname", + "description": "the name of the template for the virtual machine", + "name": "templatename", "type": "string" }, - { - "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": "the project name of the vm", - "name": "project", + "description": "the group name of the virtual machine", + "name": "group", "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": "the user's ID who deployed the virtual machine", - "name": "userid", - "type": "string" + "description": "the count of GPUs on the virtual machine", + "name": "gpucount", + "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": "true if vm has delete protection.", + "name": "deleteprotection", + "type": "boolean" }, { "description": "the list of nics associated with vm", "name": "nic", "response": [ + { + "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 ID of the nic", + "name": "id", + "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": "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": "ID of the VLAN/VNI if available", + "name": "vlanid", + "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 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": "device id for the network when plugged into the virtual machine", - "name": "deviceid", + "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 broadcast uri of the nic", - "name": "broadcasturi", + "name": "macaddress", "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": "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 traffic type of the nic", - "name": "traffictype", + "description": "the gateway of the nic", + "name": "gateway", "type": "string" }, { - "description": "ID of the VLAN/VNI if available", - "name": "vlanid", - "type": "integer" + "description": "the netmask of the nic", + "name": "netmask", + "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" }, { @@ -173754,63 +175711,58 @@ "type": "string" }, { - "description": "the ID of the corresponding network", - "name": "networkid", + "description": "the cidr of IPv6 network", + "name": "ip6cidr", "type": "string" }, { - "description": "the cidr of IPv6 network", - "name": "ip6cidr", + "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": "MTU configured on the NIC", + "name": "mtu", + "type": "integer" }, { "description": "true if nic is default, false otherwise", - "name": "macaddress", - "type": "string" + "name": "isdefault", + "type": "boolean" }, { - "description": "the gateway of IPv6 network", - "name": "ip6gateway", - "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", + "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 ID of the nic", - "name": "id", + "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": "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": "the gateway of IPv6 network", + "name": "ip6gateway", "type": "string" }, { - "description": "IP addresses associated with NIC found for unmanaged VM", - "name": "ipaddresses", - "type": "list" + "description": "the broadcast uri of the nic", + "name": "broadcasturi", + "type": "string" }, { - "description": "the ip address of the nic", - "name": "ipaddress", + "description": "the isolated private VLAN type if available", + "name": "isolatedpvlantype", "type": "string" }, { @@ -173819,444 +175771,129 @@ "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 name of the corresponding network", - "name": "networkname", + "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 isolated private VLAN if available", + "name": "isolatedpvlan", + "type": "integer" } ], "type": "set" }, { - "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": "OS type id of the vm", + "name": "ostypeid", "type": "string" }, { - "description": "the ID of the host for the virtual machine", - "name": "hostid", + "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", + "description": "the name of the gpu card to which service offering is linked", + "name": "gpucardname", "type": "string" }, { - "description": "the VM's disk read in KiB", - "name": "diskkbsread", - "type": "long" - }, - { - "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": "true if the entity/resource has annotations", - "name": "hasannotations", - "type": "boolean" - }, - { - "description": "the read (IO) of disk on the VM", - "name": "diskioread", + "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": "true if the password rest feature is enabled, false otherwise", - "name": "passwordenabled", - "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", + "description": "the list of resource tags associated", + "name": "tags", "response": [ { - "description": "the domain ID of the security group", - "name": "domainid", - "type": "string" - }, - { - "description": "the domain name of the security group", - "name": "domain", + "description": "the account associated with the tag", + "name": "account", "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", - "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 type of the ICMP message response", - "name": "icmptype", - "type": "integer" - }, - { - "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 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", - "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": "security group name", - "name": "securitygroupname", - "type": "string" - } - ], - "type": "set" - }, - { - "description": "the project id of the group", + "description": "the project id the tag belongs to", "name": "projectid", "type": "string" }, { - "description": "the description of the security group", - "name": "description", + "description": "tag key name", + "name": "key", "type": "string" }, { - "description": "path of the Domain the security group belongs to", - "name": "domainpath", + "description": "id of the resource", + "name": "resourceid", "type": "string" }, { - "description": "the project name of the group", - "name": "project", + "description": "resource type", + "name": "resourcetype", "type": "string" }, { - "description": "the name of the security group", - "name": "name", + "description": "the ID of the domain associated with the tag", + "name": "domainid", "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": "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": "tag value", - "name": "value", - "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": "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": "id of the resource", - "name": "resourceid", - "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": "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": "the domain associated with the tag", - "name": "domain", - "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" - } - ], - "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 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 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" - } - ], - "type": "set" + "description": "tag value", + "name": "value", + "type": "string" }, { - "description": "the ID of the security group", - "name": "id", + "description": "path of the Domain associated with the tag", + "name": "domainpath", "type": "string" }, { - "description": "the list of virtualmachine ids associated with this securitygroup", - "name": "virtualmachineids", - "type": "set" + "description": "the project name where tag belongs to", + "name": "project", + "type": "string" }, { - "description": "the account owning the security group", - "name": "account", + "description": "the domain associated with the tag", + "name": "domain", "type": "string" }, { - "description": "the number of virtualmachines associated with this securitygroup", - "name": "virtualmachinecount", - "type": "integer" + "description": "customer associated with the tag", + "name": "customer", + "type": "string" } ], "type": "set" }, { - "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 host for the virtual machine", + "name": "hostname", "type": "string" }, { - "description": "the ID of the vgpu profile to which service offering is linked", - "name": "vgpuprofileid", - "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 memory used by the VM in KiB", + "name": "memorykbs", + "type": "long" }, { "description": "the write (IO) of disk on the VM", @@ -174264,151 +175901,85 @@ "type": "long" }, { - "description": "the hypervisor on which the template runs", - "name": "hypervisor", + "description": "the userdata override policy with the userdata provided while deploying VM", + "name": "userdatapolicy", "type": "string" }, { - "description": "the name of the availability zone for the virtual machine", - "name": "zonename", + "description": "List of read-only Vm details as comma separated string.", + "name": "readonlydetails", "type": "string" }, { - "description": "the password (if exists) of the virtual machine", - "name": "password", + "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", + "description": "public IP address id associated with vm via Static nat rule", + "name": "publicipid", "type": "string" }, { - "description": "the memory used by the VM in KiB", - "name": "memorykbs", - "type": "long" + "description": "Instance lease expiry date", + "name": "leaseexpirydate", + "type": "date" }, { - "description": "the pool type of the virtual machine", - "name": "pooltype", + "description": "the user's ID who deployed the virtual machine", + "name": "userid", "type": "string" }, { - "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": "instance name of the user vm; this parameter is returned to the ROOT admin only", + "name": "instancename", "type": "string" }, { - "description": "the maximum Y resolution", - "name": "maxresolutiony", - "type": "long" - }, - { - "description": "path of the domain in which the virtual machine exists", - "name": "domainpath", + "description": "the ID of the domain in which the virtual machine exists", + "name": "domainid", "type": "string" }, { - "description": "the name of the vgpu profile to which service offering is linked", - "name": "vgpuprofilename", + "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": "the id of userdata used for the VM", + "name": "userdataid", + "type": "string" }, { - "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": "the name of the backup offering of the virtual machine", - "name": "backupofferingname", + "description": "the vGPU type used by the virtual machine", + "name": "vgpu", "type": "string" }, { - "description": "the speed of each vCPU", - "name": "cpuspeed", - "type": "integer" + "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": "the project name where tag belongs to", - "name": "project", - "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": "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": "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": "tag key name", - "name": "key", - "type": "string" - } - ], - "type": "set" + "description": "an alternate display text of the ISO attached to the virtual machine", + "name": "isodisplaytext", + "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": "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": "NICs of the VNF appliance", @@ -174416,84 +175987,104 @@ "type": "list" }, { - "description": "the control state of the host for the virtual machine", - "name": "hostcontrolstate", + "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 amount of the vm's CPU currently used", - "name": "cpuused", + "description": "OS name of the vm", + "name": "osdisplayname", "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 number of vCPUs this virtual machine is using", - "name": "cpunumber", - "type": "integer" + "description": "true if the entity/resource has annotations", + "name": "hasannotations", + "type": "boolean" }, { - "description": "Base64 string containing the user data", - "name": "userdata", + "description": "the hypervisor on which the template runs", + "name": "hypervisor", "type": "string" }, { - "description": "true if high-availability is enabled, false otherwise", - "name": "haenable", - "type": "boolean" - }, - { - "description": "the name of the virtual machine", - "name": "name", + "description": "the name of the service offering of the virtual machine", + "name": "serviceofferingname", "type": "string" }, { - "description": " an alternate display text of the template for the virtual machine", - "name": "templatedisplaytext", + "description": "State of the Service from LB rule", + "name": "servicestate", "type": "string" }, { - "description": "the project id of the vm", - "name": "projectid", + "description": "the group ID of the virtual machine", + "name": "groupid", "type": "string" }, { - "description": "Instance lease duration in days", - "name": "leaseduration", + "description": "the speed of each vCPU", + "name": "cpuspeed", "type": "integer" }, { - "description": "the ID of the ISO attached to the virtual machine", - "name": "isoid", + "description": "the control state of the host for the virtual machine", + "name": "hostcontrolstate", "type": "string" }, + {}, { - "description": "ssh key-pairs", - "name": "keypairs", + "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": "List of read-only Vm details as comma separated string.", - "name": "readonlydetails", + "description": "the amount of the vm's CPU currently used", + "name": "cpuused", "type": "string" }, { - "description": "the target memory in VM (KiB)", - "name": "memorytargetkbs", + "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 maximum number of display heads", + "name": "maxheads", "type": "long" }, { - "description": "an alternate display text of the ISO attached to the virtual machine", - "name": "isodisplaytext", + "description": "true if vm contains XS/VMWare tools inorder to support dynamic scaling of VM cpu/memory.", + "name": "isdynamicallyscalable", + "type": "boolean" + }, + { + "description": "the pool type of the virtual machine", + "name": "pooltype", + "type": "string" + }, + { + "description": "the format of the template for the virtual machine", + "name": "templateformat", "type": "string" }, { "description": "public IP address id associated with vm via Static nat rule", - "name": "publicipid", + "name": "publicip", + "type": "string" + }, + { + "description": "the name of the vgpu profile to which service offering is linked", + "name": "vgpuprofilename", "type": "string" } ] @@ -174503,14 +176094,6 @@ "isasync": true, "name": "createNetworkACLList", "params": [ - { - "description": "an optional field, whether to the display the list to the end user or not", - "length": 255, - "name": "fordisplay", - "required": false, - "since": "4.4", - "type": "boolean" - }, { "description": "ID of the VPC associated with this network ACL list", "length": 255, @@ -174519,6 +176102,13 @@ "required": false, "type": "uuid" }, + { + "description": "Name of the network ACL list", + "length": 255, + "name": "name", + "required": true, + "type": "string" + }, { "description": "Description of the network ACL list", "length": 255, @@ -174527,29 +176117,35 @@ "type": "string" }, { - "description": "Name of the network ACL list", + "description": "an optional field, whether to the display the list to the end user or not", "length": 255, - "name": "name", - "required": true, - "type": "string" + "name": "fordisplay", + "required": false, + "since": "4.4", + "type": "boolean" } ], "related": "", "response": [ {}, { - "description": "the Name of the ACL", - "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" + }, { "description": "Id of the VPC this ACL is associated with", "name": "vpcid", "type": "string" }, { - "description": "Description of the ACL", - "name": "description", + "description": "the Name of the ACL", + "name": "name", "type": "string" }, { @@ -174557,6 +176153,11 @@ "name": "id", "type": "string" }, + { + "description": "Description of the ACL", + "name": "description", + "type": "string" + }, { "description": "Name of the VPC this ACL is associated with", "name": "vpcname", @@ -174567,19 +176168,9 @@ "name": "fordisplay", "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" - } + {} ] } ], - "count": 899 + "count": 912 } diff --git a/test/BackupService_test.go b/test/BackupService_test.go index 9fa8329b..0ce53fbd 100644 --- a/test/BackupService_test.go +++ b/test/BackupService_test.go @@ -207,7 +207,7 @@ func TestBackupService(t *testing.T) { if _, ok := response["listBackupSchedule"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.Backup.NewListBackupScheduleParams("virtualmachineid") + p := client.Backup.NewListBackupScheduleParams() _, err := client.Backup.ListBackupSchedule(p) if err != nil { t.Errorf(err.Error()) diff --git a/test/LDAPService_test.go b/test/LDAPService_test.go index eb3632de..90fa13ec 100644 --- a/test/LDAPService_test.go +++ b/test/LDAPService_test.go @@ -40,10 +40,13 @@ func TestLDAPService(t *testing.T) { t.Skipf("Skipping as no json response is provided in testdata") } p := client.LDAP.NewAddLdapConfigurationParams("hostname", 0) - _, err := client.LDAP.AddLdapConfiguration(p) + r, err := client.LDAP.AddLdapConfiguration(p) if err != nil { t.Errorf(err.Error()) } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } } t.Run("AddLdapConfiguration", testaddLdapConfiguration) @@ -51,11 +54,14 @@ func TestLDAPService(t *testing.T) { if _, ok := response["deleteLdapConfiguration"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") } - p := client.LDAP.NewDeleteLdapConfigurationParams("hostname") - _, err := client.LDAP.DeleteLdapConfiguration(p) + p := client.LDAP.NewDeleteLdapConfigurationParams() + r, err := client.LDAP.DeleteLdapConfiguration(p) if err != nil { t.Errorf(err.Error()) } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } } t.Run("DeleteLdapConfiguration", testdeleteLdapConfiguration) From be025a4cb9be6c20a196bae0df7a0eaaf410f743 Mon Sep 17 00:00:00 2001 From: Suresh Kumar Anaparti Date: Fri, 28 Nov 2025 13:03:12 +0530 Subject: [PATCH 2/2] Added support for new APIs - updateBackupRepository, listImportVmTasks --- cloudstack/BackupService.go | 174 +++++++++++++++ cloudstack/BackupService_mock.go | 29 +++ cloudstack/VirtualMachineService.go | 261 +++++++++++++++++++++++ cloudstack/VirtualMachineService_mock.go | 29 +++ generate/layout.go | 2 + test/BackupService_test.go | 15 ++ test/VirtualMachineService_test.go | 12 ++ 7 files changed, 522 insertions(+) diff --git a/cloudstack/BackupService.go b/cloudstack/BackupService.go index bdfde23d..1a00485b 100644 --- a/cloudstack/BackupService.go +++ b/cloudstack/BackupService.go @@ -71,6 +71,8 @@ type BackupServiceIface interface { GetBackupByID(id string, opts ...OptionFunc) (*Backup, int, error) RestoreBackup(p *RestoreBackupParams) (*RestoreBackupResponse, error) NewRestoreBackupParams(id string) *RestoreBackupParams + UpdateBackupRepository(p *UpdateBackupRepositoryParams) (*UpdateBackupRepositoryResponse, error) + NewUpdateBackupRepositoryParams(id string) *UpdateBackupRepositoryParams UpdateBackupOffering(p *UpdateBackupOfferingParams) (*UpdateBackupOfferingResponse, error) NewUpdateBackupOfferingParams(id string) *UpdateBackupOfferingParams UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) @@ -4720,6 +4722,178 @@ type RestoreBackupResponse struct { Success bool `json:"success"` } +type UpdateBackupRepositoryParams struct { + p map[string]interface{} +} + +func (p *UpdateBackupRepositoryParams) 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["crosszoneinstancecreation"]; found { + vv := strconv.FormatBool(v.(bool)) + u.Set("crosszoneinstancecreation", vv) + } + if v, found := p.p["id"]; found { + u.Set("id", v.(string)) + } + if v, found := p.p["mountopts"]; found { + u.Set("mountopts", v.(string)) + } + if v, found := p.p["name"]; found { + u.Set("name", v.(string)) + } + return u +} + +func (p *UpdateBackupRepositoryParams) SetAddress(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["address"] = v +} + +func (p *UpdateBackupRepositoryParams) ResetAddress() { + if p.p != nil && p.p["address"] != nil { + delete(p.p, "address") + } +} + +func (p *UpdateBackupRepositoryParams) GetAddress() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["address"].(string) + return value, ok +} + +func (p *UpdateBackupRepositoryParams) SetCrosszoneinstancecreation(v bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["crosszoneinstancecreation"] = v +} + +func (p *UpdateBackupRepositoryParams) ResetCrosszoneinstancecreation() { + if p.p != nil && p.p["crosszoneinstancecreation"] != nil { + delete(p.p, "crosszoneinstancecreation") + } +} + +func (p *UpdateBackupRepositoryParams) GetCrosszoneinstancecreation() (bool, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["crosszoneinstancecreation"].(bool) + return value, ok +} + +func (p *UpdateBackupRepositoryParams) SetId(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["id"] = v +} + +func (p *UpdateBackupRepositoryParams) ResetId() { + if p.p != nil && p.p["id"] != nil { + delete(p.p, "id") + } +} + +func (p *UpdateBackupRepositoryParams) GetId() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["id"].(string) + return value, ok +} + +func (p *UpdateBackupRepositoryParams) SetMountopts(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["mountopts"] = v +} + +func (p *UpdateBackupRepositoryParams) ResetMountopts() { + if p.p != nil && p.p["mountopts"] != nil { + delete(p.p, "mountopts") + } +} + +func (p *UpdateBackupRepositoryParams) GetMountopts() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["mountopts"].(string) + return value, ok +} + +func (p *UpdateBackupRepositoryParams) SetName(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["name"] = v +} + +func (p *UpdateBackupRepositoryParams) ResetName() { + if p.p != nil && p.p["name"] != nil { + delete(p.p, "name") + } +} + +func (p *UpdateBackupRepositoryParams) 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 UpdateBackupRepositoryParams instance, +// as then you are sure you have configured all required params +func (s *BackupService) NewUpdateBackupRepositoryParams(id string) *UpdateBackupRepositoryParams { + p := &UpdateBackupRepositoryParams{} + p.p = make(map[string]interface{}) + p.p["id"] = id + return p +} + +// Update a backup repository +func (s *BackupService) UpdateBackupRepository(p *UpdateBackupRepositoryParams) (*UpdateBackupRepositoryResponse, error) { + resp, err := s.cs.newPostRequest("updateBackupRepository", p.toURLValues()) + if err != nil { + return nil, err + } + + var r UpdateBackupRepositoryResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type UpdateBackupRepositoryResponse struct { + Address string `json:"address"` + Capacitybytes int64 `json:"capacitybytes"` + Created string `json:"created"` + Crosszoneinstancecreation bool `json:"crosszoneinstancecreation"` + 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 UpdateBackupOfferingParams struct { p map[string]interface{} } diff --git a/cloudstack/BackupService_mock.go b/cloudstack/BackupService_mock.go index 12af665a..f38184c8 100644 --- a/cloudstack/BackupService_mock.go +++ b/cloudstack/BackupService_mock.go @@ -752,6 +752,20 @@ func (mr *MockBackupServiceIfaceMockRecorder) NewUpdateBackupOfferingParams(id a return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateBackupOfferingParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewUpdateBackupOfferingParams), id) } +// NewUpdateBackupRepositoryParams mocks base method. +func (m *MockBackupServiceIface) NewUpdateBackupRepositoryParams(id string) *UpdateBackupRepositoryParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewUpdateBackupRepositoryParams", id) + ret0, _ := ret[0].(*UpdateBackupRepositoryParams) + return ret0 +} + +// NewUpdateBackupRepositoryParams indicates an expected call of NewUpdateBackupRepositoryParams. +func (mr *MockBackupServiceIfaceMockRecorder) NewUpdateBackupRepositoryParams(id any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewUpdateBackupRepositoryParams", reflect.TypeOf((*MockBackupServiceIface)(nil).NewUpdateBackupRepositoryParams), id) +} + // NewUpdateBackupScheduleParams mocks base method. func (m *MockBackupServiceIface) NewUpdateBackupScheduleParams(intervaltype, schedule, timezone, virtualmachineid string) *UpdateBackupScheduleParams { m.ctrl.T.Helper() @@ -796,6 +810,21 @@ func (mr *MockBackupServiceIfaceMockRecorder) UpdateBackupOffering(p any) *gomoc return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateBackupOffering", reflect.TypeOf((*MockBackupServiceIface)(nil).UpdateBackupOffering), p) } +// UpdateBackupRepository mocks base method. +func (m *MockBackupServiceIface) UpdateBackupRepository(p *UpdateBackupRepositoryParams) (*UpdateBackupRepositoryResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "UpdateBackupRepository", p) + ret0, _ := ret[0].(*UpdateBackupRepositoryResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// UpdateBackupRepository indicates an expected call of UpdateBackupRepository. +func (mr *MockBackupServiceIfaceMockRecorder) UpdateBackupRepository(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "UpdateBackupRepository", reflect.TypeOf((*MockBackupServiceIface)(nil).UpdateBackupRepository), p) +} + // UpdateBackupSchedule mocks base method. func (m *MockBackupServiceIface) UpdateBackupSchedule(p *UpdateBackupScheduleParams) (*UpdateBackupScheduleResponse, error) { m.ctrl.T.Helper() diff --git a/cloudstack/VirtualMachineService.go b/cloudstack/VirtualMachineService.go index ecdbdd5e..45244e12 100644 --- a/cloudstack/VirtualMachineService.go +++ b/cloudstack/VirtualMachineService.go @@ -95,6 +95,8 @@ type VirtualMachineServiceIface interface { NewListUnmanagedInstancesParams(clusterid string) *ListUnmanagedInstancesParams ImportUnmanagedInstance(p *ImportUnmanagedInstanceParams) (*ImportUnmanagedInstanceResponse, error) NewImportUnmanagedInstanceParams(clusterid string, name string, serviceofferingid string) *ImportUnmanagedInstanceParams + ListImportVmTasks(p *ListImportVmTasksParams) (*ListImportVmTasksResponse, error) + NewListImportVmTasksParams(zoneid string) *ListImportVmTasksParams CreateVMSchedule(p *CreateVMScheduleParams) (*CreateVMScheduleResponse, error) NewCreateVMScheduleParams(action string, schedule string, timezone string, virtualmachineid string) *CreateVMScheduleParams UpdateVMSchedule(p *UpdateVMScheduleParams) (*UpdateVMScheduleResponse, error) @@ -13610,6 +13612,265 @@ func (r *ImportUnmanagedInstanceResponse) UnmarshalJSON(b []byte) error { return json.Unmarshal(b, (*alias)(r)) } +type ListImportVmTasksParams struct { + p map[string]interface{} +} + +func (p *ListImportVmTasksParams) toURLValues() url.Values { + u := url.Values{} + if p.p == nil { + return u + } + if v, found := p.p["accountid"]; found { + u.Set("accountid", v.(string)) + } + if v, found := p.p["convertinstancehostid"]; found { + u.Set("convertinstancehostid", 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["tasksfilter"]; found { + u.Set("tasksfilter", v.(string)) + } + if v, found := p.p["vcenter"]; found { + u.Set("vcenter", v.(string)) + } + if v, found := p.p["zoneid"]; found { + u.Set("zoneid", v.(string)) + } + return u +} + +func (p *ListImportVmTasksParams) SetAccountid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["accountid"] = v +} + +func (p *ListImportVmTasksParams) ResetAccountid() { + if p.p != nil && p.p["accountid"] != nil { + delete(p.p, "accountid") + } +} + +func (p *ListImportVmTasksParams) GetAccountid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["accountid"].(string) + return value, ok +} + +func (p *ListImportVmTasksParams) SetConvertinstancehostid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["convertinstancehostid"] = v +} + +func (p *ListImportVmTasksParams) ResetConvertinstancehostid() { + if p.p != nil && p.p["convertinstancehostid"] != nil { + delete(p.p, "convertinstancehostid") + } +} + +func (p *ListImportVmTasksParams) GetConvertinstancehostid() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["convertinstancehostid"].(string) + return value, ok +} + +func (p *ListImportVmTasksParams) SetKeyword(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["keyword"] = v +} + +func (p *ListImportVmTasksParams) ResetKeyword() { + if p.p != nil && p.p["keyword"] != nil { + delete(p.p, "keyword") + } +} + +func (p *ListImportVmTasksParams) GetKeyword() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["keyword"].(string) + return value, ok +} + +func (p *ListImportVmTasksParams) SetPage(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["page"] = v +} + +func (p *ListImportVmTasksParams) ResetPage() { + if p.p != nil && p.p["page"] != nil { + delete(p.p, "page") + } +} + +func (p *ListImportVmTasksParams) GetPage() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["page"].(int) + return value, ok +} + +func (p *ListImportVmTasksParams) SetPagesize(v int) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["pagesize"] = v +} + +func (p *ListImportVmTasksParams) ResetPagesize() { + if p.p != nil && p.p["pagesize"] != nil { + delete(p.p, "pagesize") + } +} + +func (p *ListImportVmTasksParams) GetPagesize() (int, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["pagesize"].(int) + return value, ok +} + +func (p *ListImportVmTasksParams) SetTasksfilter(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["tasksfilter"] = v +} + +func (p *ListImportVmTasksParams) ResetTasksfilter() { + if p.p != nil && p.p["tasksfilter"] != nil { + delete(p.p, "tasksfilter") + } +} + +func (p *ListImportVmTasksParams) GetTasksfilter() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["tasksfilter"].(string) + return value, ok +} + +func (p *ListImportVmTasksParams) SetVcenter(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["vcenter"] = v +} + +func (p *ListImportVmTasksParams) ResetVcenter() { + if p.p != nil && p.p["vcenter"] != nil { + delete(p.p, "vcenter") + } +} + +func (p *ListImportVmTasksParams) GetVcenter() (string, bool) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + value, ok := p.p["vcenter"].(string) + return value, ok +} + +func (p *ListImportVmTasksParams) SetZoneid(v string) { + if p.p == nil { + p.p = make(map[string]interface{}) + } + p.p["zoneid"] = v +} + +func (p *ListImportVmTasksParams) ResetZoneid() { + if p.p != nil && p.p["zoneid"] != nil { + delete(p.p, "zoneid") + } +} + +func (p *ListImportVmTasksParams) 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 ListImportVmTasksParams instance, +// as then you are sure you have configured all required params +func (s *VirtualMachineService) NewListImportVmTasksParams(zoneid string) *ListImportVmTasksParams { + p := &ListImportVmTasksParams{} + p.p = make(map[string]interface{}) + p.p["zoneid"] = zoneid + return p +} + +// List running import virtual machine tasks from a unmanaged hosts into CloudStack +func (s *VirtualMachineService) ListImportVmTasks(p *ListImportVmTasksParams) (*ListImportVmTasksResponse, error) { + resp, err := s.cs.newRequest("listImportVmTasks", p.toURLValues()) + if err != nil { + return nil, err + } + + var r ListImportVmTasksResponse + if err := json.Unmarshal(resp, &r); err != nil { + return nil, err + } + + return &r, nil +} + +type ListImportVmTasksResponse struct { + Count int `json:"count"` + ImportVmTasks []*ImportVmTask `json:"importvmtask"` +} + +type ImportVmTask struct { + Account string `json:"account"` + Accountid string `json:"accountid"` + Convertinstancehostid string `json:"convertinstancehostid"` + Convertinstancehostname string `json:"convertinstancehostname"` + Created string `json:"created"` + Datacentername string `json:"datacentername"` + Description string `json:"description"` + Displayname string `json:"displayname"` + Duration string `json:"duration"` + Id string `json:"id"` + JobID string `json:"jobid"` + Jobstatus int `json:"jobstatus"` + Lastupdated string `json:"lastupdated"` + Sourcevmname string `json:"sourcevmname"` + State string `json:"state"` + Step string `json:"step"` + Stepduration string `json:"stepduration"` + Vcenter string `json:"vcenter"` + Virtualmachineid string `json:"virtualmachineid"` + Zoneid string `json:"zoneid"` + Zonename string `json:"zonename"` +} + type CreateVMScheduleParams struct { p map[string]interface{} } diff --git a/cloudstack/VirtualMachineService_mock.go b/cloudstack/VirtualMachineService_mock.go index c8c4b02b..6c7192c3 100644 --- a/cloudstack/VirtualMachineService_mock.go +++ b/cloudstack/VirtualMachineService_mock.go @@ -463,6 +463,21 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) ImportVm(p any) *gomock.Ca return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ImportVm", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).ImportVm), p) } +// ListImportVmTasks mocks base method. +func (m *MockVirtualMachineServiceIface) ListImportVmTasks(p *ListImportVmTasksParams) (*ListImportVmTasksResponse, error) { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "ListImportVmTasks", p) + ret0, _ := ret[0].(*ListImportVmTasksResponse) + ret1, _ := ret[1].(error) + return ret0, ret1 +} + +// ListImportVmTasks indicates an expected call of ListImportVmTasks. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) ListImportVmTasks(p any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "ListImportVmTasks", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).ListImportVmTasks), p) +} + // ListUnmanagedInstances mocks base method. func (m *MockVirtualMachineServiceIface) ListUnmanagedInstances(p *ListUnmanagedInstancesParams) (*ListUnmanagedInstancesResponse, error) { m.ctrl.T.Helper() @@ -765,6 +780,20 @@ func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewImportVmParams(clusteri return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewImportVmParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewImportVmParams), clusterid, hypervisor, importsource, name, serviceofferingid, zoneid) } +// NewListImportVmTasksParams mocks base method. +func (m *MockVirtualMachineServiceIface) NewListImportVmTasksParams(zoneid string) *ListImportVmTasksParams { + m.ctrl.T.Helper() + ret := m.ctrl.Call(m, "NewListImportVmTasksParams", zoneid) + ret0, _ := ret[0].(*ListImportVmTasksParams) + return ret0 +} + +// NewListImportVmTasksParams indicates an expected call of NewListImportVmTasksParams. +func (mr *MockVirtualMachineServiceIfaceMockRecorder) NewListImportVmTasksParams(zoneid any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "NewListImportVmTasksParams", reflect.TypeOf((*MockVirtualMachineServiceIface)(nil).NewListImportVmTasksParams), zoneid) +} + // NewListUnmanagedInstancesParams mocks base method. func (m *MockVirtualMachineServiceIface) NewListUnmanagedInstancesParams(clusterid string) *ListUnmanagedInstancesParams { m.ctrl.T.Helper() diff --git a/generate/layout.go b/generate/layout.go index 584ee589..0a20b967 100644 --- a/generate/layout.go +++ b/generate/layout.go @@ -150,6 +150,7 @@ var layout = apiInfo{ "unmanageVirtualMachine", "listUnmanagedInstances", "importUnmanagedInstance", + "listImportVmTasks", "createVMSchedule", "updateVMSchedule", "listVMSchedule", @@ -781,6 +782,7 @@ var layout = apiInfo{ "listBackupSchedule", "listBackups", "restoreBackup", + "updateBackupRepository", "updateBackupOffering", "updateBackupSchedule", }, diff --git a/test/BackupService_test.go b/test/BackupService_test.go index 0ce53fbd..65fd7ce4 100644 --- a/test/BackupService_test.go +++ b/test/BackupService_test.go @@ -239,6 +239,21 @@ func TestBackupService(t *testing.T) { } t.Run("RestoreBackup", testrestoreBackup) + testupdateBackupRepository := func(t *testing.T) { + if _, ok := response["updateBackupRepository"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.Backup.NewUpdateBackupRepositoryParams("id") + r, err := client.Backup.UpdateBackupRepository(p) + if err != nil { + t.Errorf(err.Error()) + } + if r.Id == "" { + t.Errorf("Failed to parse response. ID not found") + } + } + t.Run("UpdateBackupRepository", testupdateBackupRepository) + testupdateBackupOffering := func(t *testing.T) { if _, ok := response["updateBackupOffering"]; !ok { t.Skipf("Skipping as no json response is provided in testdata") diff --git a/test/VirtualMachineService_test.go b/test/VirtualMachineService_test.go index 9721ff26..43becbc9 100644 --- a/test/VirtualMachineService_test.go +++ b/test/VirtualMachineService_test.go @@ -440,6 +440,18 @@ func TestVirtualMachineService(t *testing.T) { } t.Run("ImportUnmanagedInstance", testimportUnmanagedInstance) + testlistImportVmTasks := func(t *testing.T) { + if _, ok := response["listImportVmTasks"]; !ok { + t.Skipf("Skipping as no json response is provided in testdata") + } + p := client.VirtualMachine.NewListImportVmTasksParams("zoneid") + _, err := client.VirtualMachine.ListImportVmTasks(p) + if err != nil { + t.Errorf(err.Error()) + } + } + t.Run("ListImportVmTasks", testlistImportVmTasks) + testcreateVMSchedule := func(t *testing.T) { if _, ok := response["createVMSchedule"]; !ok { t.Skipf("Skipping as no json response is provided in testdata")